Class: AWSCDK::DMS::CfnReplicationConfig
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::DMS::CfnReplicationConfig
- Includes:
- IInspectable, ITaggableV2, Interfaces::AWSDMS::IReplicationConfigRef
- Defined in:
- dms/cfn_replication_config.rb
Overview
Class Method Summary collapse
- .arn_for_replication_config(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_replication_config(x) ⇒ Boolean
Checks whether the given object is a CfnReplicationConfig.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#attr_replication_config_arn ⇒ String
The Amazon Resource Name (ARN) of this AWS DMS Serverless replication configuration.
-
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
-
#compute_config ⇒ AWSCDK::IResolvable, AWSCDK::DMS::CfnReplicationConfig::ComputeConfigProperty
Configuration parameters for provisioning an AWS DMS Serverless replication.
- #compute_config=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnReplicationConfig
constructor
Create a new
AWS::DMS::ReplicationConfig. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#replication_config_identifier ⇒ String
A unique identifier that you want to use to create a
ReplicationConfigArnthat is returned as part of the output from this action. - #replication_config_identifier=(value) ⇒ Object
-
#replication_config_ref ⇒ AWSCDK::Interfaces::AWSDMS::ReplicationConfigReference
A reference to a ReplicationConfig resource.
-
#replication_settings ⇒ Object
Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.
- #replication_settings=(value) ⇒ Object
-
#replication_type ⇒ String
The type of AWS DMS Serverless replication to provision using this replication configuration.
- #replication_type=(value) ⇒ Object
-
#resource_identifier ⇒ String?
Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource.
- #resource_identifier=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#source_endpoint_arn ⇒ String
The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.
- #source_endpoint_arn=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#supplemental_settings ⇒ Object
Optional JSON settings for specifying supplemental data.
- #supplemental_settings=(value) ⇒ Object
-
#table_mappings ⇒ Object
JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.
- #table_mappings=(value) ⇒ Object
-
#tags ⇒ Array<AWSCDK::CfnTag>?
One or more optional tags associated with resources used by the AWS DMS Serverless replication.
- #tags=(value) ⇒ Object
-
#target_endpoint_arn ⇒ String
The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.
- #target_endpoint_arn=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnReplicationConfig
Create a new AWS::DMS::ReplicationConfig.
18 19 20 21 22 23 24 |
# File 'dms/cfn_replication_config.rb', line 18 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::DMS::CfnReplicationConfigProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG1zLkNmblJlcGxpY2F0aW9uQ29uZmlnUHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_replication_config(resource) ⇒ String
81 82 83 84 |
# File 'dms/cfn_replication_config.rb', line 81 def self.arn_for_replication_config(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kbXMuSVJlcGxpY2F0aW9uQ29uZmlnUmVmIn0=")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dms.CfnReplicationConfig", "arnForReplicationConfig", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
188 189 190 |
# File 'dms/cfn_replication_config.rb', line 188 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_dms.CfnReplicationConfig", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_replication_config(x) ⇒ Boolean
Checks whether the given object is a CfnReplicationConfig.
90 91 92 93 |
# File 'dms/cfn_replication_config.rb', line 90 def self.is_cfn_replication_config(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dms.CfnReplicationConfig", "isCfnReplicationConfig", [x]) end |
.jsii_overridable_methods ⇒ Object
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'dms/cfn_replication_config.rb', line 26 def self.jsii_overridable_methods { :node => { kind: :property, name: "node", is_optional: false }, :creation_stack => { kind: :property, name: "creationStack", is_optional: false }, :logical_id => { kind: :property, name: "logicalId", is_optional: false }, :stack => { kind: :property, name: "stack", is_optional: false }, :ref => { kind: :property, name: "ref", is_optional: false }, :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false }, :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false }, :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false }, :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false }, :env => { kind: :property, name: "env", is_optional: false }, :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false }, :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false }, :attr_replication_config_arn => { kind: :property, name: "attrReplicationConfigArn", is_optional: false }, :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false }, :replication_config_ref => { kind: :property, name: "replicationConfigRef", is_optional: false }, :compute_config => { kind: :property, name: "computeConfig", is_optional: false }, :replication_config_identifier => { kind: :property, name: "replicationConfigIdentifier", is_optional: false }, :replication_settings => { kind: :property, name: "replicationSettings", is_optional: false }, :replication_type => { kind: :property, name: "replicationType", is_optional: false }, :source_endpoint_arn => { kind: :property, name: "sourceEndpointArn", is_optional: false }, :supplemental_settings => { kind: :property, name: "supplementalSettings", is_optional: false }, :table_mappings => { kind: :property, name: "tableMappings", is_optional: false }, :target_endpoint_arn => { kind: :property, name: "targetEndpointArn", is_optional: false }, :resource_identifier => { kind: :property, name: "resourceIdentifier", is_optional: true }, :tags => { kind: :property, name: "tags", is_optional: true }, :to_string => { kind: :method, name: "toString", is_optional: false }, :with => { kind: :method, name: "with", is_optional: false }, :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false }, :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false }, :add_dependency => { kind: :method, name: "addDependency", is_optional: false }, :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false }, :add_metadata => { kind: :method, name: "addMetadata", is_optional: false }, :add_override => { kind: :method, name: "addOverride", is_optional: false }, :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false }, :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false }, :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false }, :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false }, :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false }, :get_att => { kind: :method, name: "getAtt", is_optional: false }, :get_metadata => { kind: :method, name: "getMetadata", is_optional: false }, :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false }, :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false }, :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false }, :render_properties => { kind: :method, name: "renderProperties", is_optional: false }, :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false }, :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false }, :validate_properties => { kind: :method, name: "validateProperties", is_optional: false }, :inspect => { kind: :method, name: "inspect", is_optional: false }, } end |
Instance Method Details
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
371 372 373 374 |
# File 'dms/cfn_replication_config.rb', line 371 def add_deletion_override(path) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") jsii_call_method("addDeletionOverride", [path]) end |
#add_dependency(target) ⇒ void
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
383 384 385 386 |
# File 'dms/cfn_replication_config.rb', line 383 def add_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependency", [target]) end |
#add_depends_on(target) ⇒ void
use addDependency
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
393 394 395 396 |
# File 'dms/cfn_replication_config.rb', line 393 def add_depends_on(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependsOn", [target]) end |
#add_metadata(key, value) ⇒ void
This method returns an undefined value.
Add a value to the CloudFormation Resource Metadata.
404 405 406 407 408 |
# File 'dms/cfn_replication_config.rb', line 404 def (key, value) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addMetadata", [key, value]) end |
#add_override(path, value) ⇒ void
This method returns an undefined value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use add_property_override or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
\ itself will need to be escaped.
For example,
# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to add_override will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
461 462 463 464 465 |
# File 'dms/cfn_replication_config.rb', line 461 def add_override(path, value) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addOverride", [path, value]) end |
#add_property_deletion_override(property_path) ⇒ void
This method returns an undefined value.
Adds an override that deletes the value of a property from the resource definition.
471 472 473 474 |
# File 'dms/cfn_replication_config.rb', line 471 def add_property_deletion_override(property_path) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") jsii_call_method("addPropertyDeletionOverride", [property_path]) end |
#add_property_override(property_path, value) ⇒ void
This method returns an undefined value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
483 484 485 486 487 |
# File 'dms/cfn_replication_config.rb', line 483 def add_property_override(property_path, value) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addPropertyOverride", [property_path, value]) end |
#apply_cross_stack_reference_strength(strength) ⇒ void
This method returns an undefined value.
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
496 497 498 499 |
# File 'dms/cfn_replication_config.rb', line 496 def apply_cross_stack_reference_strength(strength) Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength") jsii_call_method("applyCrossStackReferenceStrength", [strength]) end |
#apply_removal_policy(policy = nil, options = nil) ⇒ void
This method returns an undefined value.
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
518 519 520 521 522 523 |
# File 'dms/cfn_replication_config.rb', line 518 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_replication_config_arn ⇒ String
The Amazon Resource Name (ARN) of this AWS DMS Serverless replication configuration.
195 196 197 |
# File 'dms/cfn_replication_config.rb', line 195 def attr_replication_config_arn() jsii_get_property("attrReplicationConfigArn") end |
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
202 203 204 |
# File 'dms/cfn_replication_config.rb', line 202 def cdk_tag_manager() jsii_get_property("cdkTagManager") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
141 142 143 |
# File 'dms/cfn_replication_config.rb', line 141 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
146 147 148 |
# File 'dms/cfn_replication_config.rb', line 146 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
527 528 529 530 |
# File 'dms/cfn_replication_config.rb', line 527 def cfn_property_name(cdk_property_name) Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName") jsii_call_method("cfnPropertyName", [cdk_property_name]) end |
#cfn_property_names ⇒ Hash{String => String}
151 152 153 |
# File 'dms/cfn_replication_config.rb', line 151 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
158 159 160 |
# File 'dms/cfn_replication_config.rb', line 158 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#compute_config ⇒ AWSCDK::IResolvable, AWSCDK::DMS::CfnReplicationConfig::ComputeConfigProperty
Configuration parameters for provisioning an AWS DMS Serverless replication.
216 217 218 |
# File 'dms/cfn_replication_config.rb', line 216 def compute_config() jsii_get_property("computeConfig") end |
#compute_config=(value) ⇒ Object
220 221 222 223 224 |
# File 'dms/cfn_replication_config.rb', line 220 def compute_config=(value) value = value.is_a?(Hash) ? ::AWSCDK::DMS::CfnReplicationConfig::ComputeConfigProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuUmVwbGljYXRpb25Db25maWcuQ29tcHV0ZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "computeConfig") jsii_set_property("computeConfig", value) end |
#creation_stack ⇒ Array<String>
103 104 105 |
# File 'dms/cfn_replication_config.rb', line 103 def creation_stack() jsii_get_property("creationStack") end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
163 164 165 |
# File 'dms/cfn_replication_config.rb', line 163 def env() jsii_get_property("env") end |
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
540 541 542 543 544 |
# File 'dms/cfn_replication_config.rb', line 540 def get_att(attribute_name, type_hint = nil) Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName") Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil? jsii_call_method("getAtt", [attribute_name, type_hint]) end |
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
551 552 553 554 |
# File 'dms/cfn_replication_config.rb', line 551 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
621 622 623 624 |
# File 'dms/cfn_replication_config.rb', line 621 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use override_logical_id(new_logical_id).
115 116 117 |
# File 'dms/cfn_replication_config.rb', line 115 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
98 99 100 |
# File 'dms/cfn_replication_config.rb', line 98 def node() jsii_get_property("node") end |
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
562 563 564 |
# File 'dms/cfn_replication_config.rb', line 562 def obtain_dependencies() jsii_call_method("obtainDependencies", []) end |
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
569 570 571 |
# File 'dms/cfn_replication_config.rb', line 569 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
362 363 364 365 |
# File 'dms/cfn_replication_config.rb', line 362 def override_logical_id(new_logical_id) Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId") jsii_call_method("overrideLogicalId", [new_logical_id]) end |
#ref ⇒ String
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
134 135 136 |
# File 'dms/cfn_replication_config.rb', line 134 def ref() jsii_get_property("ref") end |
#remove_dependency(target) ⇒ void
This method returns an undefined value.
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
580 581 582 583 |
# File 'dms/cfn_replication_config.rb', line 580 def remove_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("removeDependency", [target]) end |
#render_properties(props) ⇒ Hash{String => Object}
587 588 589 590 |
# File 'dms/cfn_replication_config.rb', line 587 def render_properties(props) Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props") jsii_call_method("renderProperties", [props]) end |
#replace_dependency(target, new_target) ⇒ void
This method returns an undefined value.
Replaces one dependency with another.
597 598 599 600 601 |
# File 'dms/cfn_replication_config.rb', line 597 def replace_dependency(target, new_target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget") jsii_call_method("replaceDependency", [target, new_target]) end |
#replication_config_identifier ⇒ String
A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action.
229 230 231 |
# File 'dms/cfn_replication_config.rb', line 229 def replication_config_identifier() jsii_get_property("replicationConfigIdentifier") end |
#replication_config_identifier=(value) ⇒ Object
233 234 235 236 |
# File 'dms/cfn_replication_config.rb', line 233 def replication_config_identifier=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationConfigIdentifier") jsii_set_property("replicationConfigIdentifier", value) end |
#replication_config_ref ⇒ AWSCDK::Interfaces::AWSDMS::ReplicationConfigReference
A reference to a ReplicationConfig resource.
209 210 211 |
# File 'dms/cfn_replication_config.rb', line 209 def replication_config_ref() jsii_get_property("replicationConfigRef") end |
#replication_settings ⇒ Object
Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.
241 242 243 |
# File 'dms/cfn_replication_config.rb', line 241 def replication_settings() jsii_get_property("replicationSettings") end |
#replication_settings=(value) ⇒ Object
245 246 247 248 |
# File 'dms/cfn_replication_config.rb', line 245 def replication_settings=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "replicationSettings") jsii_set_property("replicationSettings", value) end |
#replication_type ⇒ String
The type of AWS DMS Serverless replication to provision using this replication configuration.
253 254 255 |
# File 'dms/cfn_replication_config.rb', line 253 def replication_type() jsii_get_property("replicationType") end |
#replication_type=(value) ⇒ Object
257 258 259 260 |
# File 'dms/cfn_replication_config.rb', line 257 def replication_type=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationType") jsii_set_property("replicationType", value) end |
#resource_identifier ⇒ String?
Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource.
313 314 315 |
# File 'dms/cfn_replication_config.rb', line 313 def resource_identifier() jsii_get_property("resourceIdentifier") end |
#resource_identifier=(value) ⇒ Object
317 318 319 320 |
# File 'dms/cfn_replication_config.rb', line 317 def resource_identifier=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceIdentifier") unless value.nil? jsii_set_property("resourceIdentifier", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
606 607 608 |
# File 'dms/cfn_replication_config.rb', line 606 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#source_endpoint_arn ⇒ String
The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.
265 266 267 |
# File 'dms/cfn_replication_config.rb', line 265 def source_endpoint_arn() jsii_get_property("sourceEndpointArn") end |
#source_endpoint_arn=(value) ⇒ Object
269 270 271 272 |
# File 'dms/cfn_replication_config.rb', line 269 def source_endpoint_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceEndpointArn") jsii_set_property("sourceEndpointArn", value) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
124 125 126 |
# File 'dms/cfn_replication_config.rb', line 124 def stack() jsii_get_property("stack") end |
#supplemental_settings ⇒ Object
Optional JSON settings for specifying supplemental data.
277 278 279 |
# File 'dms/cfn_replication_config.rb', line 277 def supplemental_settings() jsii_get_property("supplementalSettings") end |
#supplemental_settings=(value) ⇒ Object
281 282 283 284 |
# File 'dms/cfn_replication_config.rb', line 281 def supplemental_settings=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "supplementalSettings") jsii_set_property("supplementalSettings", value) end |
#table_mappings ⇒ Object
JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.
289 290 291 |
# File 'dms/cfn_replication_config.rb', line 289 def table_mappings() jsii_get_property("tableMappings") end |
#table_mappings=(value) ⇒ Object
293 294 295 296 |
# File 'dms/cfn_replication_config.rb', line 293 def table_mappings=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tableMappings") jsii_set_property("tableMappings", value) end |
#tags ⇒ Array<AWSCDK::CfnTag>?
One or more optional tags associated with resources used by the AWS DMS Serverless replication.
325 326 327 |
# File 'dms/cfn_replication_config.rb', line 325 def () jsii_get_property("tags") end |
#tags=(value) ⇒ Object
329 330 331 332 333 |
# File 'dms/cfn_replication_config.rb', line 329 def (value) value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil? jsii_set_property("tags", value) end |
#target_endpoint_arn ⇒ String
The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.
301 302 303 |
# File 'dms/cfn_replication_config.rb', line 301 def target_endpoint_arn() jsii_get_property("targetEndpointArn") end |
#target_endpoint_arn=(value) ⇒ Object
305 306 307 308 |
# File 'dms/cfn_replication_config.rb', line 305 def target_endpoint_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetEndpointArn") jsii_set_property("targetEndpointArn", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
338 339 340 |
# File 'dms/cfn_replication_config.rb', line 338 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Deprecated.
171 172 173 |
# File 'dms/cfn_replication_config.rb', line 171 def updated_properites() jsii_get_property("updatedProperites") end |
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
181 182 183 |
# File 'dms/cfn_replication_config.rb', line 181 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
612 613 614 615 |
# File 'dms/cfn_replication_config.rb', line 612 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
351 352 353 354 355 356 |
# File 'dms/cfn_replication_config.rb', line 351 def with(*mixins) mixins.each_with_index do |item, index| Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]") end jsii_call_method("with", [*mixins]) end |