software.amazon.awscdk.services.docdbelastic

Class CfnCluster

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.docdbelastic.CfnCluster

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.930Z")
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DocDBElastic::Cluster`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCluster.Builder A fluent builder for CfnCluster.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCluster

public CfnCluster(Construct scope,
                  java.lang.String id,
                  CfnClusterProps props)

Create a new `AWS::DocDBElastic::Cluster`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrClusterArn

public java.lang.String getAttrClusterArn()

getAttrClusterEndpoint

public java.lang.String getAttrClusterEndpoint()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to be assigned to the new elastic cluster.

getAdminUserName

public java.lang.String getAdminUserName()

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints :

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word.

setAdminUserName

public void setAdminUserName(java.lang.String value)

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints :

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word.

getAuthType

public java.lang.String getAuthType()

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Valid types are PLAIN_TEXT or SECRET_ARN .

setAuthType

public void setAuthType(java.lang.String value)

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Valid types are PLAIN_TEXT or SECRET_ARN .

getClusterName

public java.lang.String getClusterName()

The name of the new elastic cluster. This parameter is stored as a lowercase string.

Constraints :

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example : my-cluster

setClusterName

public void setClusterName(java.lang.String value)

The name of the new elastic cluster. This parameter is stored as a lowercase string.

Constraints :

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example : my-cluster

getShardCapacity

public java.lang.Number getShardCapacity()

The number of vCPUs assigned to each elastic cluster shard.

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

setShardCapacity

public void setShardCapacity(java.lang.Number value)

The number of vCPUs assigned to each elastic cluster shard.

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

getShardCount

public java.lang.Number getShardCount()

The number of shards assigned to the elastic cluster.

Maximum is 32.

setShardCount

public void setShardCount(java.lang.Number value)

The number of shards assigned to the elastic cluster.

Maximum is 32.

getAdminUserPassword

public java.lang.String getAdminUserPassword()

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints :

• Must contain from 8 to 100 characters.
• Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
• A valid AdminUserName entry is also required.

setAdminUserPassword

public void setAdminUserPassword(java.lang.String value)

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints :

• Must contain from 8 to 100 characters.
• Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
• A valid AdminUserName entry is also required.

getKmsKeyId

public java.lang.String getKmsKeyId()

The KMS key identifier to use to encrypt the new elastic cluster.

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.

setKmsKeyId

public void setKmsKeyId(java.lang.String value)

The KMS key identifier to use to encrypt the new elastic cluster.

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.

getPreferredMaintenanceWindow

public java.lang.String getPreferredMaintenanceWindow()

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(java.lang.String value)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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.

getSubnetIds

public java.util.List<java.lang.String> getSubnetIds()

The Amazon EC2 subnet IDs for the new elastic cluster.

setSubnetIds

public void setSubnetIds(java.util.List<java.lang.String> value)

The Amazon EC2 subnet IDs for the new elastic cluster.

getVpcSecurityGroupIds

public java.util.List<java.lang.String> getVpcSecurityGroupIds()

A list of EC2 VPC security groups to associate with the new elastic cluster.

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(java.util.List<java.lang.String> value)

A list of EC2 VPC security groups to associate with the new elastic cluster.