software.amazon.awscdk.services.docdb

Class CfnDBInstance

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.CfnDBInstance

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.016Z")
 @Stability(value=Stable)
public class CfnDBInstance
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DocDB::DBInstance`.

The AWS::DocDB::DBInstance Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance. For more information, see DBInstance in the Amazon DocumentDB Developer Guide .

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.docdb.*;
 CfnDBInstance cfnDBInstance = CfnDBInstance.Builder.create(this, "MyCfnDBInstance")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbInstanceClass("dbInstanceClass")
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .enablePerformanceInsights(false)
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnDBInstance(software.constructs.Construct scope, String id, CfnDBInstanceProps props) Create a new `AWS::DocDB::DBInstance`.
protected	CfnDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBInstance(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrEndpoint() The connection endpoint for the instance.
String	getAttrPort() The port number on which the database accepts connections, such as `27017` .
Object	getAutoMinorVersionUpgrade() This parameter does not apply to Amazon DocumentDB.
String	getAvailabilityZone() The Amazon EC2 Availability Zone that the instance is created in.
protected Map<String,Object>	getCfnProperties()
String	getDbClusterIdentifier() The identifier of the cluster that the instance will belong to.
String	getDbInstanceClass() The compute and memory capacity of the instance;
String	getDbInstanceIdentifier() The instance identifier.
Object	getEnablePerformanceInsights() `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
String	getPreferredMaintenanceWindow() The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
TagManager	getTags() The tags to be assigned to the instance.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoMinorVersionUpgrade(Boolean value) This parameter does not apply to Amazon DocumentDB.
void	setAutoMinorVersionUpgrade(IResolvable value) This parameter does not apply to Amazon DocumentDB.
void	setAvailabilityZone(String value) The Amazon EC2 Availability Zone that the instance is created in.
void	setDbClusterIdentifier(String value) The identifier of the cluster that the instance will belong to.
void	setDbInstanceClass(String value) The compute and memory capacity of the instance;
void	setDbInstanceIdentifier(String value) The instance identifier.
void	setEnablePerformanceInsights(Boolean value) `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
void	setEnablePerformanceInsights(IResolvable value) `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
void	setPreferredMaintenanceWindow(String value) The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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

CfnDBInstance

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

CfnDBInstance

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

CfnDBInstance

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

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

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.

getAttrEndpoint

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

The connection endpoint for the instance.

For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .

getAttrPort

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

The port number on which the database accepts connections, such as `27017` .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags to be assigned to the instance.

You can assign up to 10 tags to an instance.

getDbClusterIdentifier

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

The identifier of the cluster that the instance will belong to.

setDbClusterIdentifier

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

The identifier of the cluster that the instance will belong to.

getDbInstanceClass

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

The compute and memory capacity of the instance;

for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.

setDbInstanceClass

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

The compute and memory capacity of the instance;

for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.

getAutoMinorVersionUpgrade

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

This parameter does not apply to Amazon DocumentDB.

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

setAutoMinorVersionUpgrade

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

This parameter does not apply to Amazon DocumentDB.

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

setAutoMinorVersionUpgrade

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

This parameter does not apply to Amazon DocumentDB.

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

getAvailabilityZone

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

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

Example: us-east-1d

setAvailabilityZone

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

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

Example: us-east-1d

getDbInstanceIdentifier

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

The instance identifier. 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: mydbinstance

setDbInstanceIdentifier

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

The instance identifier. 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: mydbinstance

getEnablePerformanceInsights

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

`AWS::DocDB::DBInstance.EnablePerformanceInsights`.

setEnablePerformanceInsights

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

`AWS::DocDB::DBInstance.EnablePerformanceInsights`.

setEnablePerformanceInsights

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

`AWS::DocDB::DBInstance.EnablePerformanceInsights`.

getPreferredMaintenanceWindow

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

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is 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

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

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is 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.