Package software.amazon.awscdk.cfnpropertymixins.services.docdbelastic

Class CfnClusterMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.docdbelastic.CfnClusterMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnClusterMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnClusterMixinProps

@Stability(Stable)
@Internal
public static final class CfnClusterMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnClusterMixinProps

An implementation for CfnClusterMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.docdbelastic.CfnClusterMixinProps

CfnClusterMixinProps.Builder, CfnClusterMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnClusterMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnClusterMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAdminUserName()	The name of the Amazon DocumentDB elastic clusters administrator.
final String	getAdminUserPassword()	The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
final String	getAuthType()	The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
final Number	getBackupRetentionPeriod()	The number of days for which automatic snapshots are retained.
final String	getClusterName()	The name of the new elastic cluster.
final Object	getKmsKeyId()	The KMS key identifier to use to encrypt the new elastic cluster.
final String	getPreferredBackupWindow()	The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
final String	getPreferredMaintenanceWindow()	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
final Number	getShardCapacity()	The number of vCPUs assigned to each elastic cluster shard.
final Number	getShardCount()	The number of shards assigned to the elastic cluster.
final Number	getShardInstanceCount()	The number of replica instances applying to all shards in the cluster.
final List<String>	getSubnetIds()	The Amazon EC2 subnet IDs for the new elastic cluster.
final List<CfnTag>	getTags()	The tags to be assigned to the new elastic cluster.
final List<Object>	getVpcSecurityGroupIds()	A list of EC2 VPC security groups to associate with the new elastic cluster.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnClusterMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnClusterMixinProps.Builder.

Method Details

getAdminUserName

public final String getAdminUserName()

Description copied from interface: CfnClusterMixinProps

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.

Specified by:

getAdminUserName in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminusername

getAdminUserPassword

public final String getAdminUserPassword()

Description copied from interface: CfnClusterMixinProps

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.

Specified by:

getAdminUserPassword in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminuserpassword

getAuthType

public final String getAuthType()

Description copied from interface: CfnClusterMixinProps

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 .

Specified by:

getAuthType in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-authtype

getBackupRetentionPeriod

public final Number getBackupRetentionPeriod()

Description copied from interface: CfnClusterMixinProps

The number of days for which automatic snapshots are retained.

Specified by:

getBackupRetentionPeriod in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-backupretentionperiod

getClusterName

public final String getClusterName()

Description copied from interface: CfnClusterMixinProps

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

Specified by:

getClusterName in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-clustername

getKmsKeyId

public final Object getKmsKeyId()

Description copied from interface: CfnClusterMixinProps

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.

Returns union: either String or IKeyRef

Specified by:

getKmsKeyId in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-kmskeyid

getPreferredBackupWindow

public final String getPreferredBackupWindow()

Description copied from interface: CfnClusterMixinProps

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

Specified by:

getPreferredBackupWindow in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredbackupwindow

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: CfnClusterMixinProps

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.

Specified by:

getPreferredMaintenanceWindow in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredmaintenancewindow

getShardCapacity

public final Number getShardCapacity()

Description copied from interface: CfnClusterMixinProps

The number of vCPUs assigned to each elastic cluster shard.

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

Specified by:

getShardCapacity in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcapacity

getShardCount

public final Number getShardCount()

Description copied from interface: CfnClusterMixinProps

The number of shards assigned to the elastic cluster.

Maximum is 32.

Specified by:

getShardCount in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcount

getShardInstanceCount

public final Number getShardInstanceCount()

Description copied from interface: CfnClusterMixinProps

The number of replica instances applying to all shards in the cluster.

A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Specified by:

getShardInstanceCount in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardinstancecount

getSubnetIds

public final List<String> getSubnetIds()

Description copied from interface: CfnClusterMixinProps

The Amazon EC2 subnet IDs for the new elastic cluster.

Specified by:

getSubnetIds in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-subnetids

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnClusterMixinProps

The tags to be assigned to the new elastic cluster.

Specified by:

getTags in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-tags

getVpcSecurityGroupIds

public final List<Object> getVpcSecurityGroupIds()

Description copied from interface: CfnClusterMixinProps

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

Returns union: Listinvalid input: '<'either String or ISecurityGroupRef>

Specified by:

getVpcSecurityGroupIds in interface CfnClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-vpcsecuritygroupids

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object