1. Packages
  2. InfluxDB
  3. API Docs
  4. Organization
InfluxDB v1.2.2 published on Thursday, Sep 12, 2024 by komminarlabs

influxdb.Organization

Explore with Pulumi AI

influxdb logo
InfluxDB v1.2.2 published on Thursday, Sep 12, 2024 by komminarlabs

    Creates and manages new organization.

    Create Organization Resource

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

    Constructor syntax

    new Organization(name: string, args?: OrganizationArgs, opts?: CustomResourceOptions);
    @overload
    def Organization(resource_name: str,
                     args: Optional[OrganizationArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Organization(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None)
    func NewOrganization(ctx *Context, name string, args *OrganizationArgs, opts ...ResourceOption) (*Organization, error)
    public Organization(string name, OrganizationArgs? args = null, CustomResourceOptions? opts = null)
    public Organization(String name, OrganizationArgs args)
    public Organization(String name, OrganizationArgs args, CustomResourceOptions options)
    
    type: influxdb:Organization
    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 OrganizationArgs
    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 OrganizationArgs
    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 OrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationArgs
    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 organizationResource = new InfluxDB.Organization("organizationResource", new()
    {
        Description = "string",
        Name = "string",
    });
    
    example, err := influxdb.NewOrganization(ctx, "organizationResource", &influxdb.OrganizationArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
        .description("string")
        .name("string")
        .build());
    
    organization_resource = influxdb.Organization("organizationResource",
        description="string",
        name="string")
    
    const organizationResource = new influxdb.Organization("organizationResource", {
        description: "string",
        name: "string",
    });
    
    type: influxdb:Organization
    properties:
        description: string
        name: string
    

    Organization Resource Properties

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

    Inputs

    The Organization resource accepts the following input properties:

    Description string
    The description of the organization.
    Name string
    The name of the organization.
    Description string
    The description of the organization.
    Name string
    The name of the organization.
    description String
    The description of the organization.
    name String
    The name of the organization.
    description string
    The description of the organization.
    name string
    The name of the organization.
    description str
    The description of the organization.
    name str
    The name of the organization.
    description String
    The description of the organization.
    name String
    The name of the organization.

    Outputs

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

    CreatedAt string
    Organization creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last Organization update date.
    CreatedAt string
    Organization creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last Organization update date.
    createdAt String
    Organization creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last Organization update date.
    createdAt string
    Organization creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Last Organization update date.
    created_at str
    Organization creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Last Organization update date.
    createdAt String
    Organization creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last Organization update date.

    Look up Existing Organization Resource

    Get an existing Organization 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?: OrganizationState, opts?: CustomResourceOptions): Organization
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            updated_at: Optional[str] = None) -> Organization
    func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
    public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
    public static Organization get(String name, Output<String> id, OrganizationState 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:
    CreatedAt string
    Organization creation date.
    Description string
    The description of the organization.
    Name string
    The name of the organization.
    UpdatedAt string
    Last Organization update date.
    CreatedAt string
    Organization creation date.
    Description string
    The description of the organization.
    Name string
    The name of the organization.
    UpdatedAt string
    Last Organization update date.
    createdAt String
    Organization creation date.
    description String
    The description of the organization.
    name String
    The name of the organization.
    updatedAt String
    Last Organization update date.
    createdAt string
    Organization creation date.
    description string
    The description of the organization.
    name string
    The name of the organization.
    updatedAt string
    Last Organization update date.
    created_at str
    Organization creation date.
    description str
    The description of the organization.
    name str
    The name of the organization.
    updated_at str
    Last Organization update date.
    createdAt String
    Organization creation date.
    description String
    The description of the organization.
    name String
    The name of the organization.
    updatedAt String
    Last Organization update date.

    Package Details

    Repository
    influxdb komminarlabs/pulumi-influxdb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the influxdb Terraform Provider.
    influxdb logo
    InfluxDB v1.2.2 published on Thursday, Sep 12, 2024 by komminarlabs