1. Packages
  2. CrateDB
  3. API Docs
  4. Project
CrateDB v0.2.3 published on Friday, Oct 18, 2024 by komminarlabs

cratedb.Project

Explore with Pulumi AI

cratedb logo
CrateDB v0.2.3 published on Friday, Oct 18, 2024 by komminarlabs

    Creates and manages a project.

    Create Project Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
    @overload
    def Project(resource_name: str,
                args: ProjectArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Project(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                organization_id: Optional[str] = None,
                region: Optional[str] = None,
                name: Optional[str] = None)
    func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
    public Project(String name, ProjectArgs args, CustomResourceOptions options)
    
    type: cratedb:Project
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var projectResource = new CrateDB.Project("projectResource", new()
    {
        OrganizationId = "string",
        Region = "string",
        Name = "string",
    });
    
    example, err := cratedb.NewProject(ctx, "projectResource", &cratedb.ProjectArgs{
    	OrganizationId: pulumi.String("string"),
    	Region:         pulumi.String("string"),
    	Name:           pulumi.String("string"),
    })
    
    var projectResource = new Project("projectResource", ProjectArgs.builder()
        .organizationId("string")
        .region("string")
        .name("string")
        .build());
    
    project_resource = cratedb.Project("projectResource",
        organization_id="string",
        region="string",
        name="string")
    
    const projectResource = new cratedb.Project("projectResource", {
        organizationId: "string",
        region: "string",
        name: "string",
    });
    
    type: cratedb:Project
    properties:
        name: string
        organizationId: string
        region: string
    

    Project Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Project resource accepts the following input properties:

    OrganizationId string
    The organization id of the project.
    Region string
    The region of the project.
    Name string
    The name of the project.
    OrganizationId string
    The organization id of the project.
    Region string
    The region of the project.
    Name string
    The name of the project.
    organizationId String
    The organization id of the project.
    region String
    The region of the project.
    name String
    The name of the project.
    organizationId string
    The organization id of the project.
    region string
    The region of the project.
    name string
    The name of the project.
    organization_id str
    The organization id of the project.
    region str
    The region of the project.
    name str
    The name of the project.
    organizationId String
    The organization id of the project.
    region String
    The region of the project.
    name String
    The name of the project.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:

    Dc KomminarLabs.CrateDB.Outputs.ProjectDc
    The DublinCore of the project.
    Id string
    The provider-assigned unique ID for this managed resource.
    Dc ProjectDc
    The DublinCore of the project.
    Id string
    The provider-assigned unique ID for this managed resource.
    dc ProjectDc
    The DublinCore of the project.
    id String
    The provider-assigned unique ID for this managed resource.
    dc ProjectDc
    The DublinCore of the project.
    id string
    The provider-assigned unique ID for this managed resource.
    dc ProjectDc
    The DublinCore of the project.
    id str
    The provider-assigned unique ID for this managed resource.
    dc Property Map
    The DublinCore of the project.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Project Resource

    Get an existing Project resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProjectState, opts?: CustomResourceOptions): Project
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dc: Optional[ProjectDcArgs] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            region: Optional[str] = None) -> Project
    func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
    public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
    public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Dc KomminarLabs.CrateDB.Inputs.ProjectDc
    The DublinCore of the project.
    Name string
    The name of the project.
    OrganizationId string
    The organization id of the project.
    Region string
    The region of the project.
    Dc ProjectDcArgs
    The DublinCore of the project.
    Name string
    The name of the project.
    OrganizationId string
    The organization id of the project.
    Region string
    The region of the project.
    dc ProjectDc
    The DublinCore of the project.
    name String
    The name of the project.
    organizationId String
    The organization id of the project.
    region String
    The region of the project.
    dc ProjectDc
    The DublinCore of the project.
    name string
    The name of the project.
    organizationId string
    The organization id of the project.
    region string
    The region of the project.
    dc ProjectDcArgs
    The DublinCore of the project.
    name str
    The name of the project.
    organization_id str
    The organization id of the project.
    region str
    The region of the project.
    dc Property Map
    The DublinCore of the project.
    name String
    The name of the project.
    organizationId String
    The organization id of the project.
    region String
    The region of the project.

    Supporting Types

    ProjectDc, ProjectDcArgs

    Created string
    The created time.
    Modified string
    The modified time.
    Created string
    The created time.
    Modified string
    The modified time.
    created String
    The created time.
    modified String
    The modified time.
    created string
    The created time.
    modified string
    The modified time.
    created str
    The created time.
    modified str
    The modified time.
    created String
    The created time.
    modified String
    The modified time.

    Package Details

    Repository
    cratedb komminarlabs/pulumi-cratedb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cratedb Terraform Provider.
    cratedb logo
    CrateDB v0.2.3 published on Friday, Oct 18, 2024 by komminarlabs