Class CfnPlan.DocumentDbConfigurationProperty

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

Inheritance

object

CfnPlan.DocumentDbConfigurationProperty

Implements

CfnPlan.IDocumentDbConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ARCRegionSwitch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPlan.DocumentDbConfigurationProperty : CfnPlan.IDocumentDbConfigurationProperty

Syntax (vb)

Public Class CfnPlan.DocumentDbConfigurationProperty Implements CfnPlan.IDocumentDbConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ARCRegionSwitch;

             var documentDbConfigurationProperty = new DocumentDbConfigurationProperty {
                 Behavior = "behavior",
                 DatabaseClusterArns = new [] { "databaseClusterArns" },
                 GlobalClusterIdentifier = "globalClusterIdentifier",

                 // the properties below are optional
                 CrossAccountRole = "crossAccountRole",
                 ExternalId = "externalId",
                 TimeoutMinutes = 123,
                 Ungraceful = new DocumentDbUngracefulProperty {
                     Ungraceful = "ungraceful"
                 }
             };

Synopsis

Constructors

DocumentDbConfigurationProperty()

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

Properties

Behavior	The behavior for a global cluster, that is, only allow switchover or also allow failover.
CrossAccountRole	The cross account role for the configuration.
DatabaseClusterArns	The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
ExternalId	The external ID (secret key) for the configuration.
GlobalClusterIdentifier	The global cluster identifier for a DocumentDB global cluster.
TimeoutMinutes	The timeout value specified for the configuration.
Ungraceful	The settings for ungraceful execution.

Constructors

DocumentDbConfigurationProperty()

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

public DocumentDbConfigurationProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ARCRegionSwitch;

             var documentDbConfigurationProperty = new DocumentDbConfigurationProperty {
                 Behavior = "behavior",
                 DatabaseClusterArns = new [] { "databaseClusterArns" },
                 GlobalClusterIdentifier = "globalClusterIdentifier",

                 // the properties below are optional
                 CrossAccountRole = "crossAccountRole",
                 ExternalId = "externalId",
                 TimeoutMinutes = 123,
                 Ungraceful = new DocumentDbUngracefulProperty {
                     Ungraceful = "ungraceful"
                 }
             };

Properties

Behavior

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

public string Behavior { get; set; }

Property Value

string

Remarks

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

CrossAccountRole

The cross account role for the configuration.

public string? CrossAccountRole { get; set; }

Property Value

string

Remarks

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

DatabaseClusterArns

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

public string[] DatabaseClusterArns { get; set; }

Property Value

string[]

Remarks

ExternalId

The external ID (secret key) for the configuration.

public string? ExternalId { get; set; }

Property Value

string

Remarks

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

GlobalClusterIdentifier

The global cluster identifier for a DocumentDB global cluster.

public string GlobalClusterIdentifier { get; set; }

Property Value

string

Remarks

TimeoutMinutes

The timeout value specified for the configuration.

public double? TimeoutMinutes { get; set; }

Property Value

double?

Remarks

Default: - 60

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

Ungraceful

The settings for ungraceful execution.

public object? Ungraceful { get; set; }