1. Packages
  2. AWS Native
  3. API Docs
  4. docdbelastic
  5. Cluster

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.docdbelastic.Cluster

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster

    Create Cluster Resource

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                admin_user_name: Optional[str] = None,
                admin_user_password: Optional[str] = None,
                auth_type: Optional[str] = None,
                cluster_name: Optional[str] = None,
                kms_key_id: Optional[str] = None,
                preferred_maintenance_window: Optional[str] = None,
                shard_capacity: Optional[int] = None,
                shard_count: Optional[int] = None,
                subnet_ids: Optional[Sequence[str]] = None,
                tags: Optional[Sequence[ClusterTagArgs]] = None,
                vpc_security_group_ids: Optional[Sequence[str]] = None)
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws-native:docdbelastic:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster 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 Cluster resource accepts the following input properties:

    Outputs

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

    ClusterArn string
    ClusterEndpoint string
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterArn string
    ClusterEndpoint string
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterArn String
    clusterEndpoint String
    id String
    The provider-assigned unique ID for this managed resource.
    clusterArn string
    clusterEndpoint string
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_arn str
    cluster_endpoint str
    id str
    The provider-assigned unique ID for this managed resource.
    clusterArn String
    clusterEndpoint String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ClusterTag, ClusterTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi