Package software.amazon.awscdk.cfnpropertymixins.services.neptune

Class CfnDBClusterMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.neptune.CfnDBClusterMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnDBClusterMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDBClusterMixinProps

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

An implementation for CfnDBClusterMixinProps

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.neptune.CfnDBClusterMixinProps

CfnDBClusterMixinProps.Builder, CfnDBClusterMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDBClusterMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDBClusterMixinProps.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 Object	getAssociatedRoles()	Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
final List<String>	getAvailabilityZones()	Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
final Number	getBackupRetentionPeriod()	Specifies the number of days for which automatic DB snapshots are retained.
final Object	getCopyTagsToSnapshot()	If set to true , tags are copied to any snapshot of the DB cluster that is created..
final String	getDbClusterIdentifier()	Contains a user-supplied DB cluster identifier.
final String	getDbClusterParameterGroupName()	Provides the name of the DB cluster parameter group.
final String	getDbInstanceParameterGroupName()	The name of the DB parameter group to apply to all instances of the DB cluster.
final Number	getDbPort()	The port number on which the DB instances in the DB cluster accept connections.
final String	getDbSubnetGroupName()	Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
final Object	getDeletionProtection()	Indicates whether or not the DB cluster has deletion protection enabled.
final List<String>	getEnableCloudwatchLogsExports()	Specifies a list of log types that are enabled for export to CloudWatch Logs.
final String	getEngineVersion()	Indicates the database engine version.
final Object	getIamAuthEnabled()	True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
final Object	getKmsKeyId()	The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .
final String	getPreferredBackupWindow()	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
final String	getPreferredMaintenanceWindow()	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
final String	getRestoreToTime()	Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
final String	getRestoreType()	Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
final Object	getServerlessScalingConfiguration()	Contains the scaling configuration of an Neptune Serverless DB cluster.
final String	getSnapshotIdentifier()	Specifies the identifier for a DB cluster snapshot.
final String	getSourceDbClusterIdentifier()	Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
final Object	getStorageEncrypted()	Indicates whether the DB cluster is encrypted.
final List<CfnTag>	getTags()	The tags assigned to this cluster.
final Object	getUseLatestRestorableTime()	Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
final List<Object>	getVpcSecurityGroupIds()	Provides a list of VPC security groups that the DB cluster belongs to.
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(CfnDBClusterMixinProps.Builder builder)

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

Method Details

getAssociatedRoles

public final Object getAssociatedRoles()

Description copied from interface: CfnDBClusterMixinProps

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDBClusterPropsMixin.DBClusterRoleProperty>

Specified by:

getAssociatedRoles in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-associatedroles

getAvailabilityZones

public final List<String> getAvailabilityZones()

Description copied from interface: CfnDBClusterMixinProps

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Specified by:

getAvailabilityZones in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-availabilityzones

getBackupRetentionPeriod

public final Number getBackupRetentionPeriod()

Description copied from interface: CfnDBClusterMixinProps

Specifies the number of days for which automatic DB snapshots are retained.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Default: - 1

Specified by:

getBackupRetentionPeriod in interface CfnDBClusterMixinProps

See Also:

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

getCopyTagsToSnapshot

public final Object getCopyTagsToSnapshot()

Description copied from interface: CfnDBClusterMixinProps

If set to true , tags are copied to any snapshot of the DB cluster that is created..

Returns union: either Boolean or IResolvable

Specified by:

getCopyTagsToSnapshot in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-copytagstosnapshot

getDbClusterIdentifier

public final String getDbClusterIdentifier()

Description copied from interface: CfnDBClusterMixinProps

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

Specified by:

getDbClusterIdentifier in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusteridentifier

getDbClusterParameterGroupName

public final String getDbClusterParameterGroupName()

Description copied from interface: CfnDBClusterMixinProps

Provides the name of the DB cluster parameter group.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Specified by:

getDbClusterParameterGroupName in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusterparametergroupname

getDbInstanceParameterGroupName

public final String getDbInstanceParameterGroupName()

Description copied from interface: CfnDBClusterMixinProps

The name of the DB parameter group to apply to all instances of the DB cluster.

Used only in case of a major engine version upgrade request

Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

• The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.

Specified by:

getDbInstanceParameterGroupName in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbinstanceparametergroupname

getDbPort

public final Number getDbPort()

Description copied from interface: CfnDBClusterMixinProps

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182 .

The Port property will soon be deprecated. Please update existing templates to use the new DBPort property that has the same functionality.

Specified by:

getDbPort in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbport

getDbSubnetGroupName

public final String getDbSubnetGroupName()

Description copied from interface: CfnDBClusterMixinProps

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Specified by:

getDbSubnetGroupName in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbsubnetgroupname

getDeletionProtection

public final Object getDeletionProtection()

Description copied from interface: CfnDBClusterMixinProps

Indicates whether or not the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled.

Returns union: either Boolean or IResolvable

Specified by:

getDeletionProtection in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-deletionprotection

getEnableCloudwatchLogsExports

public final List<String> getEnableCloudwatchLogsExports()

Description copied from interface: CfnDBClusterMixinProps

Specifies a list of log types that are enabled for export to CloudWatch Logs.

Specified by:

getEnableCloudwatchLogsExports in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-enablecloudwatchlogsexports

getEngineVersion

public final String getEngineVersion()

Description copied from interface: CfnDBClusterMixinProps

Indicates the database engine version.

Specified by:

getEngineVersion in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-engineversion

getIamAuthEnabled

public final Object getIamAuthEnabled()

Description copied from interface: CfnDBClusterMixinProps

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns union: either Boolean or IResolvable

Specified by:

getIamAuthEnabled in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-iamauthenabled

getKmsKeyId

public final Object getKmsKeyId()

Description copied from interface: CfnDBClusterMixinProps

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .

Returns union: either String or IKeyRef

Specified by:

getKmsKeyId in interface CfnDBClusterMixinProps

See Also:

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

getPreferredBackupWindow

public final String getPreferredBackupWindow()

Description copied from interface: CfnDBClusterMixinProps

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

An update may require some interruption.

Specified by:

getPreferredBackupWindow in interface CfnDBClusterMixinProps

See Also:

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

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: CfnDBClusterMixinProps

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

Specified by:

getPreferredMaintenanceWindow in interface CfnDBClusterMixinProps

See Also:

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

getRestoreToTime

public final String getRestoreToTime()

Description copied from interface: CfnDBClusterMixinProps

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Specified by:

getRestoreToTime in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretotime

getRestoreType

public final String getRestoreType()

Description copied from interface: CfnDBClusterMixinProps

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Default: - "full-copy"

Specified by:

getRestoreType in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-restoretype

getServerlessScalingConfiguration

public final Object getServerlessScalingConfiguration()

Description copied from interface: CfnDBClusterMixinProps

Contains the scaling configuration of an Neptune Serverless DB cluster.

Returns union: either IResolvable or CfnDBClusterPropsMixin.ServerlessScalingConfigurationProperty

Specified by:

getServerlessScalingConfiguration in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-serverlessscalingconfiguration

getSnapshotIdentifier

public final String getSnapshotIdentifier()

Description copied from interface: CfnDBClusterMixinProps

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

Specified by:

getSnapshotIdentifier in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier

getSourceDbClusterIdentifier

public final String getSourceDbClusterIdentifier()

Description copied from interface: CfnDBClusterMixinProps

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Specified by:

getSourceDbClusterIdentifier in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-sourcedbclusteridentifier

getStorageEncrypted

public final Object getStorageEncrypted()

Description copied from interface: CfnDBClusterMixinProps

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true .

If you enable the StorageEncrypted property but don't specify the KmsKeyId property, then the default KMS key is used. If you specify the KmsKeyId property, then that KMS key is used to encrypt the database instances in the DB cluster.

If you specify the SourceDBClusterIdentifier property, and don't specify this property or disable it, the value is inherited from the source DB cluster. If the source DB cluster is encrypted, the KmsKeyId property from the source cluster is used.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it, the value is inherited from the snapshot and the specified KmsKeyId property from the snapshot is used.

Returns union: either Boolean or IResolvable

Specified by:

getStorageEncrypted in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-storageencrypted

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDBClusterMixinProps

The tags assigned to this cluster.

Specified by:

getTags in interface CfnDBClusterMixinProps

See Also:

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

getUseLatestRestorableTime

public final Object getUseLatestRestorableTime()

Description copied from interface: CfnDBClusterMixinProps

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns union: either Boolean or IResolvable

Specified by:

getUseLatestRestorableTime in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-uselatestrestorabletime

getVpcSecurityGroupIds

public final List<Object> getVpcSecurityGroupIds()

Description copied from interface: CfnDBClusterMixinProps

Provides a list of VPC security groups that the DB cluster belongs to.

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

Specified by:

getVpcSecurityGroupIds in interface CfnDBClusterMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-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