@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.930Z") public class CfnCluster extends CfnResource implements IInspectable
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.docdbelastic.*; CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster") .adminUserName("adminUserName") .authType("authType") .clusterName("clusterName") .shardCapacity(123) .shardCount(123) // the properties below are optional .adminUserPassword("adminUserPassword") .kmsKeyId("kmsKeyId") .preferredMaintenanceWindow("preferredMaintenanceWindow") .subnetIds(List.of("subnetIds")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds")) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnCluster.Builder
A fluent builder for
CfnCluster . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCluster(Construct scope,
java.lang.String id,
CfnClusterProps props)
Create a new `AWS::DocDBElastic::Cluster`.
|
protected |
CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnCluster(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAdminUserName()
The name of the Amazon DocumentDB elastic clusters administrator.
|
java.lang.String |
getAdminUserPassword()
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
|
java.lang.String |
getAttrClusterArn() |
java.lang.String |
getAttrClusterEndpoint() |
java.lang.String |
getAuthType()
The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getClusterName()
The name of the new elastic cluster.
|
java.lang.String |
getKmsKeyId()
The KMS key identifier to use to encrypt the new elastic cluster.
|
java.lang.String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
java.lang.Number |
getShardCapacity()
The number of vCPUs assigned to each elastic cluster shard.
|
java.lang.Number |
getShardCount()
The number of shards assigned to the elastic cluster.
|
java.util.List<java.lang.String> |
getSubnetIds()
The Amazon EC2 subnet IDs for the new elastic cluster.
|
TagManager |
getTags()
The tags to be assigned to the new elastic cluster.
|
java.util.List<java.lang.String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the new elastic cluster.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAdminUserName(java.lang.String value)
The name of the Amazon DocumentDB elastic clusters administrator.
|
void |
setAdminUserPassword(java.lang.String value)
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
|
void |
setAuthType(java.lang.String value)
The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
|
void |
setClusterName(java.lang.String value)
The name of the new elastic cluster.
|
void |
setKmsKeyId(java.lang.String value)
The KMS key identifier to use to encrypt the new elastic cluster.
|
void |
setPreferredMaintenanceWindow(java.lang.String value)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setShardCapacity(java.lang.Number value)
The number of vCPUs assigned to each elastic cluster shard.
|
void |
setShardCount(java.lang.Number value)
The number of shards assigned to the elastic cluster.
|
void |
setSubnetIds(java.util.List<java.lang.String> value)
The Amazon EC2 subnet IDs for the new elastic cluster.
|
void |
setVpcSecurityGroupIds(java.util.List<java.lang.String> value)
A list of EC2 VPC security groups to associate with the new elastic cluster.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCluster(Construct scope, java.lang.String id, CfnClusterProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrClusterArn()
public java.lang.String getAttrClusterEndpoint()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getAdminUserName()
Constraints :
public void setAdminUserName(java.lang.String value)
Constraints :
public java.lang.String getAuthType()
Valid types are PLAIN_TEXT
or SECRET_ARN
.
public void setAuthType(java.lang.String value)
Valid types are PLAIN_TEXT
or SECRET_ARN
.
public java.lang.String getClusterName()
Constraints :
Example : my-cluster
public void setClusterName(java.lang.String value)
Constraints :
Example : my-cluster
public java.lang.Number getShardCapacity()
Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
public void setShardCapacity(java.lang.Number value)
Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
public java.lang.Number getShardCount()
Maximum is 32.
public void setShardCount(java.lang.Number value)
Maximum is 32.
public java.lang.String getAdminUserPassword()
Constraints :
AdminUserName
entry is also required.public void setAdminUserPassword(java.lang.String value)
Constraints :
AdminUserName
entry is also required.public java.lang.String getKmsKeyId()
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
public void setKmsKeyId(java.lang.String value)
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
public java.lang.String getPreferredMaintenanceWindow()
Format : ddd:hh24:mi-ddd:hh24:mi
Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints : Minimum 30-minute window.
public void setPreferredMaintenanceWindow(java.lang.String value)
Format : ddd:hh24:mi-ddd:hh24:mi
Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints : Minimum 30-minute window.
public java.util.List<java.lang.String> getSubnetIds()
public void setSubnetIds(java.util.List<java.lang.String> value)
public java.util.List<java.lang.String> getVpcSecurityGroupIds()
public void setVpcSecurityGroupIds(java.util.List<java.lang.String> value)