interface DocumentDbConfigurationProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ARCRegionSwitch.CfnPlanPropsMixin.DocumentDbConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsarcregionswitch#CfnPlanPropsMixin_DocumentDbConfigurationProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.arcregionswitch.CfnPlanPropsMixin.DocumentDbConfigurationProperty
Python	aws_cdk.cfn_property_mixins.aws_arcregionswitch.CfnPlanPropsMixin.DocumentDbConfigurationProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_arcregionswitch » CfnPlanPropsMixin » DocumentDbConfigurationProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_arcregionswitch as arcregionswitch } from '@aws-cdk/cfn-property-mixins';
const documentDbConfigurationProperty: arcregionswitch.CfnPlanPropsMixin.DocumentDbConfigurationProperty = {
  behavior: 'behavior',
  crossAccountRole: 'crossAccountRole',
  databaseClusterArns: ['databaseClusterArns'],
  externalId: 'externalId',
  globalClusterIdentifier: 'globalClusterIdentifier',
  timeoutMinutes: 123,
  ungraceful: {
    ungraceful: 'ungraceful',
  },
};

Properties

Name	Type	Description
behavior?	string	The behavior for a global cluster, that is, only allow switchover or also allow failover.
crossAccountRole?	string	The cross account role for the configuration.
databaseClusterArns?	string[]	The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
externalId?	string	The external ID (secret key) for the configuration.
globalClusterIdentifier?	string	The global cluster identifier for a DocumentDB global cluster.
timeoutMinutes?	number	The timeout value specified for the configuration.
ungraceful?	IResolvable | DocumentDbUngracefulProperty	The settings for ungraceful execution.

---

behavior?

Type: string (optional)

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

---

crossAccountRole?

Type: string (optional)

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

---

databaseClusterArns?

Type: string[] (optional)

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

---

externalId?

Type: string (optional)

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

---

globalClusterIdentifier?

Type: string (optional)

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

---

timeoutMinutes?

Type: number (optional, default: 60)

The timeout value specified for the configuration.

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

---

ungraceful?

Type: IResolvable | DocumentDbUngracefulProperty (optional)

The settings for ungraceful execution.

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