software.amazon.awscdk.services.docdb

Class CfnDBCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.docdb.CfnDBCluster

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.882Z")
 @Stability(value=Stable)
public class CfnDBCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DocDB::DBCluster`.

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBCluster(software.constructs.Construct scope, String id, CfnDBClusterProps props) Create a new `AWS::DocDB::DBCluster`.
protected	CfnDBCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrClusterResourceId()
String	getAttrEndpoint()
String	getAttrPort()
String	getAttrReadEndpoint()
List<String>	getAvailabilityZones() `AWS::DocDB::DBCluster.AvailabilityZones`.
Number	getBackupRetentionPeriod() `AWS::DocDB::DBCluster.BackupRetentionPeriod`.
protected Map<String,Object>	getCfnProperties()
String	getDbClusterIdentifier() `AWS::DocDB::DBCluster.DBClusterIdentifier`.
String	getDbClusterParameterGroupName() `AWS::DocDB::DBCluster.DBClusterParameterGroupName`.
String	getDbSubnetGroupName() `AWS::DocDB::DBCluster.DBSubnetGroupName`.
Object	getDeletionProtection() `AWS::DocDB::DBCluster.DeletionProtection`.
List<String>	getEnableCloudwatchLogsExports() `AWS::DocDB::DBCluster.EnableCloudwatchLogsExports`.
String	getEngineVersion() `AWS::DocDB::DBCluster.EngineVersion`.
String	getKmsKeyId() `AWS::DocDB::DBCluster.KmsKeyId`.
String	getMasterUsername() `AWS::DocDB::DBCluster.MasterUsername`.
String	getMasterUserPassword() `AWS::DocDB::DBCluster.MasterUserPassword`.
Number	getPort() `AWS::DocDB::DBCluster.Port`.
String	getPreferredBackupWindow() `AWS::DocDB::DBCluster.PreferredBackupWindow`.
String	getPreferredMaintenanceWindow() `AWS::DocDB::DBCluster.PreferredMaintenanceWindow`.
String	getSnapshotIdentifier() `AWS::DocDB::DBCluster.SnapshotIdentifier`.
Object	getStorageEncrypted() `AWS::DocDB::DBCluster.StorageEncrypted`.
TagManager	getTags() `AWS::DocDB::DBCluster.Tags`.
List<String>	getVpcSecurityGroupIds() `AWS::DocDB::DBCluster.VpcSecurityGroupIds`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZones(List<String> value) `AWS::DocDB::DBCluster.AvailabilityZones`.
void	setBackupRetentionPeriod(Number value) `AWS::DocDB::DBCluster.BackupRetentionPeriod`.
void	setDbClusterIdentifier(String value) `AWS::DocDB::DBCluster.DBClusterIdentifier`.
void	setDbClusterParameterGroupName(String value) `AWS::DocDB::DBCluster.DBClusterParameterGroupName`.
void	setDbSubnetGroupName(String value) `AWS::DocDB::DBCluster.DBSubnetGroupName`.
void	setDeletionProtection(Boolean value) `AWS::DocDB::DBCluster.DeletionProtection`.
void	setDeletionProtection(IResolvable value) `AWS::DocDB::DBCluster.DeletionProtection`.
void	setEnableCloudwatchLogsExports(List<String> value) `AWS::DocDB::DBCluster.EnableCloudwatchLogsExports`.
void	setEngineVersion(String value) `AWS::DocDB::DBCluster.EngineVersion`.
void	setKmsKeyId(String value) `AWS::DocDB::DBCluster.KmsKeyId`.
void	setMasterUsername(String value) `AWS::DocDB::DBCluster.MasterUsername`.
void	setMasterUserPassword(String value) `AWS::DocDB::DBCluster.MasterUserPassword`.
void	setPort(Number value) `AWS::DocDB::DBCluster.Port`.
void	setPreferredBackupWindow(String value) `AWS::DocDB::DBCluster.PreferredBackupWindow`.
void	setPreferredMaintenanceWindow(String value) `AWS::DocDB::DBCluster.PreferredMaintenanceWindow`.
void	setSnapshotIdentifier(String value) `AWS::DocDB::DBCluster.SnapshotIdentifier`.
void	setStorageEncrypted(Boolean value) `AWS::DocDB::DBCluster.StorageEncrypted`.
void	setStorageEncrypted(IResolvable value) `AWS::DocDB::DBCluster.StorageEncrypted`.
void	setVpcSecurityGroupIds(List<String> value) `AWS::DocDB::DBCluster.VpcSecurityGroupIds`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBCluster

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

CfnDBCluster

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

CfnDBCluster

@Stability(value=Stable)
public CfnDBCluster(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnDBClusterProps props)

Create a new `AWS::DocDB::DBCluster`.

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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrClusterResourceId

@Stability(value=Stable)
 @NotNull
public String getAttrClusterResourceId()

getAttrEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrEndpoint()

getAttrPort

@Stability(value=Stable)
 @NotNull
public String getAttrPort()

getAttrReadEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrReadEndpoint()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::DocDB::DBCluster.Tags`.

getMasterUsername

@Stability(value=Stable)
 @NotNull
public String getMasterUsername()

`AWS::DocDB::DBCluster.MasterUsername`.

setMasterUsername

@Stability(value=Stable)
public void setMasterUsername(@NotNull
                                                       String value)

`AWS::DocDB::DBCluster.MasterUsername`.

getMasterUserPassword

@Stability(value=Stable)
 @NotNull
public String getMasterUserPassword()

`AWS::DocDB::DBCluster.MasterUserPassword`.

setMasterUserPassword

@Stability(value=Stable)
public void setMasterUserPassword(@NotNull
                                                           String value)

`AWS::DocDB::DBCluster.MasterUserPassword`.

getAvailabilityZones

@Stability(value=Stable)
 @Nullable
public List<String> getAvailabilityZones()

`AWS::DocDB::DBCluster.AvailabilityZones`.

setAvailabilityZones

@Stability(value=Stable)
public void setAvailabilityZones(@Nullable
                                                          List<String> value)

`AWS::DocDB::DBCluster.AvailabilityZones`.

getBackupRetentionPeriod

@Stability(value=Stable)
 @Nullable
public Number getBackupRetentionPeriod()

`AWS::DocDB::DBCluster.BackupRetentionPeriod`.

setBackupRetentionPeriod

@Stability(value=Stable)
public void setBackupRetentionPeriod(@Nullable
                                                              Number value)

`AWS::DocDB::DBCluster.BackupRetentionPeriod`.

getDbClusterIdentifier

@Stability(value=Stable)
 @Nullable
public String getDbClusterIdentifier()

`AWS::DocDB::DBCluster.DBClusterIdentifier`.

setDbClusterIdentifier

@Stability(value=Stable)
public void setDbClusterIdentifier(@Nullable
                                                            String value)

`AWS::DocDB::DBCluster.DBClusterIdentifier`.

getDbClusterParameterGroupName

@Stability(value=Stable)
 @Nullable
public String getDbClusterParameterGroupName()

`AWS::DocDB::DBCluster.DBClusterParameterGroupName`.

setDbClusterParameterGroupName

@Stability(value=Stable)
public void setDbClusterParameterGroupName(@Nullable
                                                                    String value)

`AWS::DocDB::DBCluster.DBClusterParameterGroupName`.

getDbSubnetGroupName

@Stability(value=Stable)
 @Nullable
public String getDbSubnetGroupName()

`AWS::DocDB::DBCluster.DBSubnetGroupName`.

setDbSubnetGroupName

@Stability(value=Stable)
public void setDbSubnetGroupName(@Nullable
                                                          String value)

`AWS::DocDB::DBCluster.DBSubnetGroupName`.

getDeletionProtection

@Stability(value=Stable)
 @Nullable
public Object getDeletionProtection()

`AWS::DocDB::DBCluster.DeletionProtection`.

setDeletionProtection

@Stability(value=Stable)
public void setDeletionProtection(@Nullable
                                                           Boolean value)

`AWS::DocDB::DBCluster.DeletionProtection`.

setDeletionProtection

@Stability(value=Stable)
public void setDeletionProtection(@Nullable
                                                           IResolvable value)

`AWS::DocDB::DBCluster.DeletionProtection`.

getEnableCloudwatchLogsExports

@Stability(value=Stable)
 @Nullable
public List<String> getEnableCloudwatchLogsExports()

`AWS::DocDB::DBCluster.EnableCloudwatchLogsExports`.

setEnableCloudwatchLogsExports

@Stability(value=Stable)
public void setEnableCloudwatchLogsExports(@Nullable
                                                                    List<String> value)

`AWS::DocDB::DBCluster.EnableCloudwatchLogsExports`.

getEngineVersion

@Stability(value=Stable)
 @Nullable
public String getEngineVersion()

`AWS::DocDB::DBCluster.EngineVersion`.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

`AWS::DocDB::DBCluster.EngineVersion`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

`AWS::DocDB::DBCluster.KmsKeyId`.

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

`AWS::DocDB::DBCluster.KmsKeyId`.

getPort

@Stability(value=Stable)
 @Nullable
public Number getPort()

`AWS::DocDB::DBCluster.Port`.

setPort

@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)

`AWS::DocDB::DBCluster.Port`.

getPreferredBackupWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredBackupWindow()

`AWS::DocDB::DBCluster.PreferredBackupWindow`.

setPreferredBackupWindow

@Stability(value=Stable)
public void setPreferredBackupWindow(@Nullable
                                                              String value)

`AWS::DocDB::DBCluster.PreferredBackupWindow`.

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

`AWS::DocDB::DBCluster.PreferredMaintenanceWindow`.

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

`AWS::DocDB::DBCluster.PreferredMaintenanceWindow`.

getSnapshotIdentifier

@Stability(value=Stable)
 @Nullable
public String getSnapshotIdentifier()

`AWS::DocDB::DBCluster.SnapshotIdentifier`.

setSnapshotIdentifier

@Stability(value=Stable)
public void setSnapshotIdentifier(@Nullable
                                                           String value)

`AWS::DocDB::DBCluster.SnapshotIdentifier`.

getStorageEncrypted

@Stability(value=Stable)
 @Nullable
public Object getStorageEncrypted()

`AWS::DocDB::DBCluster.StorageEncrypted`.

setStorageEncrypted

@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         Boolean value)

`AWS::DocDB::DBCluster.StorageEncrypted`.

setStorageEncrypted

@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         IResolvable value)

`AWS::DocDB::DBCluster.StorageEncrypted`.

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroupIds()

`AWS::DocDB::DBCluster.VpcSecurityGroupIds`.

setVpcSecurityGroupIds

@Stability(value=Stable)
public void setVpcSecurityGroupIds(@Nullable
                                                            List<String> value)

`AWS::DocDB::DBCluster.VpcSecurityGroupIds`.