AWS Native is in preview. AWS Classic is fully supported.
aws-native.docdbelastic.Cluster
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
shard_capacity: Optional[int] = None,
shard_count: Optional[int] = None,
auth_type: Optional[str] = None,
admin_user_name: Optional[str] = None,
backup_retention_period: Optional[int] = None,
kms_key_id: Optional[str] = None,
preferred_backup_window: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
cluster_name: Optional[str] = None,
admin_user_password: Optional[str] = None,
shard_instance_count: Optional[int] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
vpc_security_group_ids: Optional[Sequence[str]] = 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.
Parameters
- 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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const clusterResource = new aws_native.docdbelastic.Cluster("clusterResource", {
shardCapacity: 0,
shardCount: 0,
authType: "string",
adminUserName: "string",
backupRetentionPeriod: 0,
kmsKeyId: "string",
preferredBackupWindow: "string",
preferredMaintenanceWindow: "string",
clusterName: "string",
adminUserPassword: "string",
shardInstanceCount: 0,
subnetIds: ["string"],
tags: [{
key: "string",
value: "string",
}],
vpcSecurityGroupIds: ["string"],
});
Coming soon!
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:
- Admin
User stringName - Auth
Type string - int
- int
- Admin
User stringPassword - Backup
Retention intPeriod - Cluster
Name string - Kms
Key stringId - Preferred
Backup stringWindow - Preferred
Maintenance stringWindow - int
- Subnet
Ids List<string> - List<Pulumi.
Aws Native. Inputs. Tag> - Vpc
Security List<string>Group Ids
- Admin
User stringName - Auth
Type string - int
- int
- Admin
User stringPassword - Backup
Retention intPeriod - Cluster
Name string - Kms
Key stringId - Preferred
Backup stringWindow - Preferred
Maintenance stringWindow - int
- Subnet
Ids []string - Tag
Args - Vpc
Security []stringGroup Ids
- admin
User StringName - auth
Type String - Integer
- Integer
- admin
User StringPassword - backup
Retention IntegerPeriod - cluster
Name String - kms
Key StringId - preferred
Backup StringWindow - preferred
Maintenance StringWindow - Integer
- subnet
Ids List<String> - List<Tag>
- vpc
Security List<String>Group Ids
- admin
User stringName - auth
Type string - number
- number
- admin
User stringPassword - backup
Retention numberPeriod - cluster
Name string - kms
Key stringId - preferred
Backup stringWindow - preferred
Maintenance stringWindow - number
- subnet
Ids string[] - Tag[]
- vpc
Security string[]Group Ids
- admin_
user_ strname - auth_
type str - int
- int
- admin_
user_ strpassword - backup_
retention_ intperiod - cluster_
name str - kms_
key_ strid - preferred_
backup_ strwindow - preferred_
maintenance_ strwindow - int
- subnet_
ids Sequence[str] - Sequence[Tag
Args] - vpc_
security_ Sequence[str]group_ ids
- admin
User StringName - auth
Type String - Number
- Number
- admin
User StringPassword - backup
Retention NumberPeriod - cluster
Name String - kms
Key StringId - preferred
Backup StringWindow - preferred
Maintenance StringWindow - Number
- subnet
Ids List<String> - List<Property Map>
- vpc
Security List<String>Group Ids
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Cluster
Arn string - Cluster
Endpoint string - Id string
- The provider-assigned unique ID for this managed resource.
- Cluster
Arn string - Cluster
Endpoint string - Id string
- The provider-assigned unique ID for this managed resource.
- cluster
Arn String - cluster
Endpoint String - id String
- The provider-assigned unique ID for this managed resource.
- cluster
Arn string - cluster
Endpoint 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.
- cluster
Arn String - cluster
Endpoint String - id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.