DocumentDbConfigurationProperty Struct
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
Example
ts
// 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-lib';
const documentDbConfigurationProperty: arcregionswitch.CfnPlan.DocumentDbConfigurationProperty = {
behavior: 'behavior',
databaseClusterArns: ['databaseClusterArns'],
globalClusterIdentifier: 'globalClusterIdentifier',
// the properties below are optional
crossAccountRole: 'crossAccountRole',
externalId: 'externalId',
timeoutMinutes: 123,
ungraceful: {
ungraceful: 'ungraceful',
},
};
Properties
The behavior for a global cluster, that is, only allow switchover or also allow failover.
crossAccountRoleoptionalstringcross_account_roleoptionalstrcrossAccountRoleoptionalStringCrossAccountRoleoptionalstringCrossAccountRoleoptional*string#The cross account role for the configuration.
databaseClusterArnsstring[]database_cluster_arnstyping.List[str]databaseClusterArnsList<String>DatabaseClusterArnsstring[]DatabaseClusterArns*[]*stringrequired#The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
externalIdoptionalstringexternal_idoptionalstrexternalIdoptionalStringExternalIdoptionalstringExternalIdoptional*string#The external ID (secret key) for the configuration.
globalClusterIdentifierstringglobal_cluster_identifierstrglobalClusterIdentifierStringGlobalClusterIdentifierstringGlobalClusterIdentifier*stringrequired#The global cluster identifier for a DocumentDB global cluster.
timeoutMinutesoptionalnumbertimeout_minutesoptionalint | floattimeoutMinutesoptionalNumberTimeoutMinutesoptionaldoubleTimeoutMinutesoptional*float64= 60#The timeout value specified for the configuration.
ungracefuloptionalIResolvable | CfnPlan.DocumentDbUngracefulPropertyungracefuloptionaltyping.Union[IResolvable, DocumentDbUngracefulProperty]ungracefuloptionalIResolvableUngracefuloptionalIResolvableUngracefuloptionalinterface{}#The settings for ungraceful execution.