software.amazon.awscdk.services.docdb

Class CfnDBInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.docdb.CfnDBInstance

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/0.20.5 (build a820217)",
           date="2019-11-13T14:31:12.743Z")
 @Stability(value=External)
public class CfnDBInstance
extends CfnResource
implements IInspectable

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html

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.core.IInspectable

IInspectable.Jsii$Proxy

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(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()
String	getAttrPort()
Object	getAutoMinorVersionUpgrade() `AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.
String	getAvailabilityZone() `AWS::DocDB::DBInstance.AvailabilityZone`.
protected Map<String,Object>	getCfnProperties()
String	getDbClusterIdentifier() `AWS::DocDB::DBInstance.DBClusterIdentifier`.
String	getDbInstanceClass() `AWS::DocDB::DBInstance.DBInstanceClass`.
String	getDbInstanceIdentifier() `AWS::DocDB::DBInstance.DBInstanceIdentifier`.
String	getPreferredMaintenanceWindow() `AWS::DocDB::DBInstance.PreferredMaintenanceWindow`.
TagManager	getTags() `AWS::DocDB::DBInstance.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoMinorVersionUpgrade(Boolean value) `AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.
void	setAutoMinorVersionUpgrade(IResolvable value) `AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.
void	setAvailabilityZone(String value) `AWS::DocDB::DBInstance.AvailabilityZone`.
void	setDbClusterIdentifier(String value) `AWS::DocDB::DBInstance.DBClusterIdentifier`.
void	setDbInstanceClass(String value) `AWS::DocDB::DBInstance.DBInstanceClass`.
void	setDbInstanceIdentifier(String value) `AWS::DocDB::DBInstance.DBInstanceIdentifier`.
void	setPreferredMaintenanceWindow(String value) `AWS::DocDB::DBInstance.PreferredMaintenanceWindow`.

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

addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getUpdatedProperites, isCfnResource, 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, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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=External)
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=External)
public CfnDBInstance(Construct scope,
                                                String id,
                                                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=Experimental)
public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes. EXPERIMENTAL

Specified by:

inspect in interface IInspectable

Parameters:

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

renderProperties

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEndpoint

@Stability(value=External)
public String getAttrEndpoint()

getAttrPort

@Stability(value=External)
public String getAttrPort()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=External)
public TagManager getTags()

`AWS::DocDB::DBInstance.Tags`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags

getDbClusterIdentifier

@Stability(value=External)
public String getDbClusterIdentifier()

`AWS::DocDB::DBInstance.DBClusterIdentifier`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier

setDbClusterIdentifier

@Stability(value=External)
public void setDbClusterIdentifier(String value)

`AWS::DocDB::DBInstance.DBClusterIdentifier`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier

getDbInstanceClass

@Stability(value=External)
public String getDbInstanceClass()

`AWS::DocDB::DBInstance.DBInstanceClass`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass

setDbInstanceClass

@Stability(value=External)
public void setDbInstanceClass(String value)

`AWS::DocDB::DBInstance.DBInstanceClass`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass

getAutoMinorVersionUpgrade

@Stability(value=External)
public Object getAutoMinorVersionUpgrade()

`AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade

setAutoMinorVersionUpgrade

@Stability(value=External)
public void setAutoMinorVersionUpgrade(Boolean value)

`AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade

setAutoMinorVersionUpgrade

@Stability(value=External)
public void setAutoMinorVersionUpgrade(IResolvable value)

`AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade

getAvailabilityZone

@Stability(value=External)
public String getAvailabilityZone()

`AWS::DocDB::DBInstance.AvailabilityZone`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone

setAvailabilityZone

@Stability(value=External)
public void setAvailabilityZone(String value)

`AWS::DocDB::DBInstance.AvailabilityZone`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone

getDbInstanceIdentifier

@Stability(value=External)
public String getDbInstanceIdentifier()

`AWS::DocDB::DBInstance.DBInstanceIdentifier`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier

setDbInstanceIdentifier

@Stability(value=External)
public void setDbInstanceIdentifier(String value)

`AWS::DocDB::DBInstance.DBInstanceIdentifier`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier

getPreferredMaintenanceWindow

@Stability(value=External)
public String getPreferredMaintenanceWindow()

`AWS::DocDB::DBInstance.PreferredMaintenanceWindow`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow

setPreferredMaintenanceWindow

@Stability(value=External)
public void setPreferredMaintenanceWindow(String value)

`AWS::DocDB::DBInstance.PreferredMaintenanceWindow`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow