Package software.amazon.awscdk.services.arcregionswitch

Interface CfnPlan.DocumentDbConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlan.DocumentDbConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPlan

@Stability(Stable)
public static interface CfnPlan.DocumentDbConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for Amazon DocumentDB global clusters used in a Region switch plan.

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.arcregionswitch.*;
 DocumentDbConfigurationProperty documentDbConfigurationProperty = DocumentDbConfigurationProperty.builder()
         .behavior("behavior")
         .databaseClusterArns(List.of("databaseClusterArns"))
         .globalClusterIdentifier("globalClusterIdentifier")
         // the properties below are optional
         .crossAccountRole("crossAccountRole")
         .externalId("externalId")
         .timeoutMinutes(123)
         .ungraceful(DocumentDbUngracefulProperty.builder()
                 .ungraceful("ungraceful")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPlan.DocumentDbConfigurationProperty.Builder	builder()
String	getBehavior()	The behavior for a global cluster, that is, only allow switchover or also allow failover.
default String	getCrossAccountRole()	The cross account role for the configuration.
List<String>	getDatabaseClusterArns()	The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
default String	getExternalId()	The external ID (secret key) for the configuration.
String	getGlobalClusterIdentifier()	The global cluster identifier for a DocumentDB global cluster.
default Number	getTimeoutMinutes()	The timeout value specified for the configuration.
default Object	getUngraceful()	The settings for ungraceful execution.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBehavior

@Stability(Stable)
@NotNull
String getBehavior()

The behavior for a global cluster, that is, only allow switchover or also allow failover.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-behavior

getDatabaseClusterArns

@Stability(Stable)
@NotNull
List<String> getDatabaseClusterArns()

The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-databaseclusterarns

getGlobalClusterIdentifier

@Stability(Stable)
@NotNull
String getGlobalClusterIdentifier()

The global cluster identifier for a DocumentDB global cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-globalclusteridentifier

getCrossAccountRole

@Stability(Stable)
@Nullable
default String getCrossAccountRole()

The cross account role for the configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-crossaccountrole

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

The external ID (secret key) for the configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-externalid

getTimeoutMinutes

@Stability(Stable)
@Nullable
default Number getTimeoutMinutes()

The timeout value specified for the configuration.

Default: - 60

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-timeoutminutes

getUngraceful

@Stability(Stable)
@Nullable
default Object getUngraceful()

The settings for ungraceful execution.

Returns union: either IResolvable or CfnPlan.DocumentDbUngracefulProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-documentdbconfiguration.html#cfn-arcregionswitch-plan-documentdbconfiguration-ungraceful

builder

@Stability(Stable)
static CfnPlan.DocumentDbConfigurationProperty.Builder builder()

Returns:

a CfnPlan.DocumentDbConfigurationProperty.Builder of CfnPlan.DocumentDbConfigurationProperty