Class: AWSCDK::DMS::CfnMigrationProjectProps

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

Overview

Properties for defining a CfnMigrationProject.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, instance_profile_arn: nil, instance_profile_identifier: nil, instance_profile_name: nil, migration_project_creation_time: nil, migration_project_identifier: nil, migration_project_name: nil, schema_conversion_application_attributes: nil, source_data_provider_descriptors: nil, tags: nil, target_data_provider_descriptors: nil, transformation_rules: nil) ⇒ CfnMigrationProjectProps

Returns a new instance of CfnMigrationProjectProps.

Parameters:

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

    A user-friendly description of the migration project.

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

    The Amazon Resource Name (ARN) of the instance profile for your migration project.

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

    The identifier of the instance profile for your migration project.

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

    The name of the associated instance profile.

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

    The property describes a creating time of the migration project.

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

    The identifier of the migration project.

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

    The name of the migration project.

  • schema_conversion_application_attributes (AWSCDK::IResolvable, AWSCDK::DMS::CfnMigrationProject::SchemaConversionApplicationAttributesProperty, nil) (defaults to: nil) —

    The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

  • source_data_provider_descriptors (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::DMS::CfnMigrationProject::DataProviderDescriptorProperty>, nil) (defaults to: nil) —

    Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

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

    An array of key-value pairs to apply to this resource.

  • target_data_provider_descriptors (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::DMS::CfnMigrationProject::DataProviderDescriptorProperty>, nil) (defaults to: nil) —

    Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

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

    The settings in JSON format for migration rules.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'dms/cfn_migration_project_props.rb', line 21

def initialize(description: nil, instance_profile_arn: nil, instance_profile_identifier: nil, instance_profile_name: nil, migration_project_creation_time: nil, migration_project_identifier: nil, migration_project_name: nil, schema_conversion_application_attributes: nil, source_data_provider_descriptors: nil, tags: nil, target_data_provider_descriptors: nil, transformation_rules: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @instance_profile_arn = instance_profile_arn
  Jsii::Type.check_type(@instance_profile_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceProfileArn") unless @instance_profile_arn.nil?
  @instance_profile_identifier = instance_profile_identifier
  Jsii::Type.check_type(@instance_profile_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceProfileIdentifier") unless @instance_profile_identifier.nil?
  @instance_profile_name = instance_profile_name
  Jsii::Type.check_type(@instance_profile_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceProfileName") unless @instance_profile_name.nil?
  @migration_project_creation_time = migration_project_creation_time
  Jsii::Type.check_type(@migration_project_creation_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "migrationProjectCreationTime") unless @migration_project_creation_time.nil?
  @migration_project_identifier = migration_project_identifier
  Jsii::Type.check_type(@migration_project_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "migrationProjectIdentifier") unless @migration_project_identifier.nil?
  @migration_project_name = migration_project_name
  Jsii::Type.check_type(@migration_project_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "migrationProjectName") unless @migration_project_name.nil?
  @schema_conversion_application_attributes = schema_conversion_application_attributes.is_a?(Hash) ? ::AWSCDK::DMS::CfnMigrationProject::SchemaConversionApplicationAttributesProperty.new(**schema_conversion_application_attributes.transform_keys(&:to_sym)) : schema_conversion_application_attributes
  Jsii::Type.check_type(@schema_conversion_application_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbXMuQ2ZuTWlncmF0aW9uUHJvamVjdC5TY2hlbWFDb252ZXJzaW9uQXBwbGljYXRpb25BdHRyaWJ1dGVzUHJvcGVydHkifV19fQ==")), "schemaConversionApplicationAttributes") unless @schema_conversion_application_attributes.nil?
  @source_data_provider_descriptors = source_data_provider_descriptors
  Jsii::Type.check_type(@source_data_provider_descriptors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG1zLkNmbk1pZ3JhdGlvblByb2plY3QuRGF0YVByb3ZpZGVyRGVzY3JpcHRvclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "sourceDataProviderDescriptors") unless @source_data_provider_descriptors.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?
  @target_data_provider_descriptors = target_data_provider_descriptors
  Jsii::Type.check_type(@target_data_provider_descriptors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG1zLkNmbk1pZ3JhdGlvblByb2plY3QuRGF0YVByb3ZpZGVyRGVzY3JpcHRvclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "targetDataProviderDescriptors") unless @target_data_provider_descriptors.nil?
  @transformation_rules = transformation_rules
  Jsii::Type.check_type(@transformation_rules, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transformationRules") unless @transformation_rules.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A user-friendly description of the migration project.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'dms/cfn_migration_project_props.rb', line 52

def description
  @description
end

#instance_profile_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the instance profile for your migration project.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'dms/cfn_migration_project_props.rb', line 57

def instance_profile_arn
  @instance_profile_arn
end

#instance_profile_identifier ⇒ String? (readonly)

The identifier of the instance profile for your migration project.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'dms/cfn_migration_project_props.rb', line 62

def instance_profile_identifier
  @instance_profile_identifier
end

#instance_profile_name ⇒ String? (readonly)

The name of the associated instance profile.

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'dms/cfn_migration_project_props.rb', line 67

def instance_profile_name
  @instance_profile_name
end

#migration_project_creation_time ⇒ String? (readonly)

Deprecated.

this property has been deprecated

The property describes a creating time of the migration project.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'dms/cfn_migration_project_props.rb', line 73

def migration_project_creation_time
  @migration_project_creation_time
end

#migration_project_identifier ⇒ String? (readonly)

The identifier of the migration project.

Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

Returns:

  • (String, nil)

See Also:



80
81
82
 
# File 'dms/cfn_migration_project_props.rb', line 80

def migration_project_identifier
  @migration_project_identifier
end

#migration_project_name ⇒ String? (readonly)

The name of the migration project.

Returns:

  • (String, nil)

See Also:



85
86
87
 
# File 'dms/cfn_migration_project_props.rb', line 85

def migration_project_name
  @migration_project_name
end

#schema_conversion_application_attributes ⇒ AWSCDK::IResolvable, ... (readonly)

The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

Returns:

See Also:



90
91
92
 
# File 'dms/cfn_migration_project_props.rb', line 90

def schema_conversion_application_attributes
  @schema_conversion_application_attributes
end

#source_data_provider_descriptors ⇒ AWSCDK::IResolvable, ... (readonly)

Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

Returns:

See Also:



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

def source_data_provider_descriptors
  @source_data_provider_descriptors
end

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

An array of key-value pairs to apply to this resource.

Returns:

See Also:



100
101
102
 
# File 'dms/cfn_migration_project_props.rb', line 100

def tags
  @tags
end

#target_data_provider_descriptors ⇒ AWSCDK::IResolvable, ... (readonly)

Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

Returns:

See Also:



105
106
107
 
# File 'dms/cfn_migration_project_props.rb', line 105

def target_data_provider_descriptors
  @target_data_provider_descriptors
end

#transformation_rules ⇒ String? (readonly)

The settings in JSON format for migration rules.

Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

Returns:

  • (String, nil)

See Also:



112
113
114
 
# File 'dms/cfn_migration_project_props.rb', line 112

def transformation_rules
  @transformation_rules
end

Class Method Details

.jsii_properties ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'dms/cfn_migration_project_props.rb', line 114

def self.jsii_properties
  {
    :description => "description",
    :instance_profile_arn => "instanceProfileArn",
    :instance_profile_identifier => "instanceProfileIdentifier",
    :instance_profile_name => "instanceProfileName",
    :migration_project_creation_time => "migrationProjectCreationTime",
    :migration_project_identifier => "migrationProjectIdentifier",
    :migration_project_name => "migrationProjectName",
    :schema_conversion_application_attributes => "schemaConversionApplicationAttributes",
    :source_data_provider_descriptors => "sourceDataProviderDescriptors",
    :tags => "tags",
    :target_data_provider_descriptors => "targetDataProviderDescriptors",
    :transformation_rules => "transformationRules",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'dms/cfn_migration_project_props.rb', line 131

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "instanceProfileArn" => @instance_profile_arn,
    "instanceProfileIdentifier" => @instance_profile_identifier,
    "instanceProfileName" => @instance_profile_name,
    "migrationProjectCreationTime" => @migration_project_creation_time,
    "migrationProjectIdentifier" => @migration_project_identifier,
    "migrationProjectName" => @migration_project_name,
    "schemaConversionApplicationAttributes" => @schema_conversion_application_attributes,
    "sourceDataProviderDescriptors" => @source_data_provider_descriptors,
    "tags" => @tags,
    "targetDataProviderDescriptors" => @target_data_provider_descriptors,
    "transformationRules" => @transformation_rules,
  })
  result.compact
end