software.amazon.awscdk.services.docdb

Interface CfnDBInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.831Z")
 @Stability(value=Stable)
public interface CfnDBInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::DocDB::DBInstance`.

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.*;
 CfnDBInstanceProps cfnDBInstanceProps = CfnDBInstanceProps.builder()
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbInstanceClass("dbInstanceClass")
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDBInstanceProps.Builder A builder for CfnDBInstanceProps
static class	CfnDBInstanceProps.Jsii$Proxy An implementation for CfnDBInstanceProps

Method Summary

Modifier and Type	Method and Description
static CfnDBInstanceProps.Builder	builder()
default Object	getAutoMinorVersionUpgrade() `AWS::DocDB::DBInstance.AutoMinorVersionUpgrade`.
default String	getAvailabilityZone() `AWS::DocDB::DBInstance.AvailabilityZone`.
String	getDbClusterIdentifier() `AWS::DocDB::DBInstance.DBClusterIdentifier`.
String	getDbInstanceClass() `AWS::DocDB::DBInstance.DBInstanceClass`.
default String	getDbInstanceIdentifier() `AWS::DocDB::DBInstance.DBInstanceIdentifier`.
default String	getPreferredMaintenanceWindow() `AWS::DocDB::DBInstance.PreferredMaintenanceWindow`.
default List<CfnTag>	getTags() `AWS::DocDB::DBInstance.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoMinorVersionUpgrade

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

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

getAvailabilityZone

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

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

getDbClusterIdentifier

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

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

getDbInstanceClass

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

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

getDbInstanceIdentifier

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

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

getPreferredMaintenanceWindow

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

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

builder

@Stability(value=Stable)
static CfnDBInstanceProps.Builder builder()

Returns:

a CfnDBInstanceProps.Builder of CfnDBInstanceProps