Class: AWSCDK::DMS::CfnReplicationConfigProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_replication_config_props.rb

Overview

Properties for defining a CfnReplicationConfig.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(compute_config:, replication_config_identifier:, replication_type:, source_endpoint_arn:, table_mappings:, target_endpoint_arn:, replication_settings: nil, resource_identifier: nil, supplemental_settings: nil, tags: nil) ⇒ CfnReplicationConfigProps

Returns a new instance of CfnReplicationConfigProps.

Parameters:

  • compute_config (AWSCDK::IResolvable, AWSCDK::DMS::CfnReplicationConfig::ComputeConfigProperty) —

    Configuration parameters for provisioning an AWS DMS Serverless replication.

  • 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.

  • replication_type (String) —

    The type of AWS DMS Serverless replication to provision using this replication configuration.

  • source_endpoint_arn (String) —

    The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.

  • table_mappings (Object) —

    JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.

  • target_endpoint_arn (String) —

    The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.

  • replication_settings (Object, nil) (defaults to: nil) —

    Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.

  • resource_identifier (String, nil) (defaults to: nil) —

    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.

  • supplemental_settings (Object, nil) (defaults to: nil) —

    Optional JSON settings for specifying supplemental data.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    One or more optional tags associated with resources used by the AWS DMS Serverless replication.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'dms/cfn_replication_config_props.rb', line 19

def initialize(compute_config:, replication_config_identifier:, replication_type:, source_endpoint_arn:, table_mappings:, target_endpoint_arn:, replication_settings: nil, resource_identifier: nil, supplemental_settings: nil, tags: nil)
  @compute_config = compute_config.is_a?(Hash) ? ::AWSCDK::DMS::CfnReplicationConfig::ComputeConfigProperty.new(**compute_config.transform_keys(&:to_sym)) : compute_config
  Jsii::Type.check_type(@compute_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuUmVwbGljYXRpb25Db25maWcuQ29tcHV0ZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "computeConfig")
  @replication_config_identifier = replication_config_identifier
  Jsii::Type.check_type(@replication_config_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationConfigIdentifier")
  @replication_type = replication_type
  Jsii::Type.check_type(@replication_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationType")
  @source_endpoint_arn = source_endpoint_arn
  Jsii::Type.check_type(@source_endpoint_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceEndpointArn")
  @table_mappings = table_mappings
  Jsii::Type.check_type(@table_mappings, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tableMappings")
  @target_endpoint_arn = target_endpoint_arn
  Jsii::Type.check_type(@target_endpoint_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetEndpointArn")
  @replication_settings = replication_settings
  Jsii::Type.check_type(@replication_settings, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "replicationSettings") unless @replication_settings.nil?
  @resource_identifier = resource_identifier
  Jsii::Type.check_type(@resource_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceIdentifier") unless @resource_identifier.nil?
  @supplemental_settings = supplemental_settings
  Jsii::Type.check_type(@supplemental_settings, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "supplementalSettings") unless @supplemental_settings.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#compute_config ⇒ AWSCDK::IResolvable, AWSCDK::DMS::CfnReplicationConfig::ComputeConfigProperty (readonly)

Configuration parameters for provisioning an AWS DMS Serverless replication.

Returns:

See Also:



46
47
48
 
# File 'dms/cfn_replication_config_props.rb', line 46

def compute_config
  @compute_config
end

#replication_config_identifier ⇒ String (readonly)

A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action.

You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both AWS DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.

Returns:

  • (String)

See Also:



53
54
55
 
# File 'dms/cfn_replication_config_props.rb', line 53

def replication_config_identifier
  @replication_config_identifier
end

#replication_settings ⇒ Object? (readonly)

Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.

For example, see Change processing tuning settings .

Returns:

  • (Object, nil)

See Also:



88
89
90
 
# File 'dms/cfn_replication_config_props.rb', line 88

def replication_settings
  @replication_settings
end

#replication_type ⇒ String (readonly)

The type of AWS DMS Serverless replication to provision using this replication configuration.

Possible values:

  • "full-load"
  • "cdc"
  • "full-load-and-cdc"

Returns:

  • (String)

See Also:



64
65
66
 
# File 'dms/cfn_replication_config_props.rb', line 64

def replication_type
  @replication_type
end

#resource_identifier ⇒ String? (readonly)

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.

For more information, see Fine-grained access control using resource names and tags .

Returns:

  • (String, nil)

See Also:



95
96
97
 
# File 'dms/cfn_replication_config_props.rb', line 95

def resource_identifier
  @resource_identifier
end

#source_endpoint_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.

Returns:

  • (String)

See Also:



69
70
71
 
# File 'dms/cfn_replication_config_props.rb', line 69

def source_endpoint_arn
  @source_endpoint_arn
end

#supplemental_settings ⇒ Object? (readonly)

Optional JSON settings for specifying supplemental data.

For more information, see Specifying supplemental data for task settings .

Returns:

  • (Object, nil)

See Also:



102
103
104
 
# File 'dms/cfn_replication_config_props.rb', line 102

def supplemental_settings
  @supplemental_settings
end

#table_mappings ⇒ Object (readonly)

JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.

For more information, see Specifying table selection and transformations rules using JSON .

Returns:

  • (Object)

See Also:



76
77
78
 
# File 'dms/cfn_replication_config_props.rb', line 76

def table_mappings
  @table_mappings
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

One or more optional tags associated with resources used by the AWS DMS Serverless replication.

For more information, see Tagging resources in AWS Database Migration Service .

Returns:

See Also:



109
110
111
 
# File 'dms/cfn_replication_config_props.rb', line 109

def tags
  @tags
end

#target_endpoint_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.

Returns:

  • (String)

See Also:



81
82
83
 
# File 'dms/cfn_replication_config_props.rb', line 81

def target_endpoint_arn
  @target_endpoint_arn
end

Class Method Details

.jsii_properties ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'dms/cfn_replication_config_props.rb', line 111

def self.jsii_properties
  {
    :compute_config => "computeConfig",
    :replication_config_identifier => "replicationConfigIdentifier",
    :replication_type => "replicationType",
    :source_endpoint_arn => "sourceEndpointArn",
    :table_mappings => "tableMappings",
    :target_endpoint_arn => "targetEndpointArn",
    :replication_settings => "replicationSettings",
    :resource_identifier => "resourceIdentifier",
    :supplemental_settings => "supplementalSettings",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'dms/cfn_replication_config_props.rb', line 126

def to_jsii
  result = {}
  result.merge!({
    "computeConfig" => @compute_config,
    "replicationConfigIdentifier" => @replication_config_identifier,
    "replicationType" => @replication_type,
    "sourceEndpointArn" => @source_endpoint_arn,
    "tableMappings" => @table_mappings,
    "targetEndpointArn" => @target_endpoint_arn,
    "replicationSettings" => @replication_settings,
    "resourceIdentifier" => @resource_identifier,
    "supplementalSettings" => @supplemental_settings,
    "tags" => @tags,
  })
  result.compact
end