Class: AWSCDK::DMS::CfnMigrationProject::DataProviderDescriptorProperty

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

Overview

Information about a data provider.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_provider_arn: nil, data_provider_identifier: nil, data_provider_name: nil, secrets_manager_access_role_arn: nil, secrets_manager_secret_id: nil) ⇒ DataProviderDescriptorProperty

Returns a new instance of DataProviderDescriptorProperty.

Parameters:

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

    The Amazon Resource Name (ARN) of the data provider.

  • data_provider_identifier (String, nil) (defaults to: nil)
  • data_provider_name (String, nil) (defaults to: nil) —

    The user-friendly name of the data provider.

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

    The ARN of the role used to access AWS Secrets Manager.

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

    The identifier of the AWS Secrets Manager Secret used to store access credentials for the data provider.



666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'dms/cfn_migration_project.rb', line 666

def initialize(data_provider_arn: nil, data_provider_identifier: nil, data_provider_name: nil, secrets_manager_access_role_arn: nil, secrets_manager_secret_id: nil)
  @data_provider_arn = data_provider_arn
  Jsii::Type.check_type(@data_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataProviderArn") unless @data_provider_arn.nil?
  @data_provider_identifier = data_provider_identifier
  Jsii::Type.check_type(@data_provider_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataProviderIdentifier") unless @data_provider_identifier.nil?
  @data_provider_name = data_provider_name
  Jsii::Type.check_type(@data_provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataProviderName") unless @data_provider_name.nil?
  @secrets_manager_access_role_arn = secrets_manager_access_role_arn
  Jsii::Type.check_type(@secrets_manager_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerAccessRoleArn") unless @secrets_manager_access_role_arn.nil?
  @secrets_manager_secret_id = secrets_manager_secret_id
  Jsii::Type.check_type(@secrets_manager_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerSecretId") unless @secrets_manager_secret_id.nil?
end

Instance Attribute Details

#data_provider_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the data provider.

Returns:

  • (String, nil)

See Also:



683
684
685
 
# File 'dms/cfn_migration_project.rb', line 683

def data_provider_arn
  @data_provider_arn
end

#data_provider_identifier ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



686
687
688
 
# File 'dms/cfn_migration_project.rb', line 686

def data_provider_identifier
  @data_provider_identifier
end

#data_provider_name ⇒ String? (readonly)

The user-friendly name of the data provider.

Returns:

  • (String, nil)

See Also:



691
692
693
 
# File 'dms/cfn_migration_project.rb', line 691

def data_provider_name
  @data_provider_name
end

#secrets_manager_access_role_arn ⇒ String? (readonly)

The ARN of the role used to access AWS Secrets Manager.

Returns:

  • (String, nil)

See Also:



696
697
698
 
# File 'dms/cfn_migration_project.rb', line 696

def secrets_manager_access_role_arn
  @secrets_manager_access_role_arn
end

#secrets_manager_secret_id ⇒ String? (readonly)

The identifier of the AWS Secrets Manager Secret used to store access credentials for the data provider.

Returns:

  • (String, nil)

See Also:



701
702
703
 
# File 'dms/cfn_migration_project.rb', line 701

def secrets_manager_secret_id
  @secrets_manager_secret_id
end

Class Method Details

.jsii_properties ⇒ Object 



703
704
705
706
707
708
709
710
711
 
# File 'dms/cfn_migration_project.rb', line 703

def self.jsii_properties
  {
    :data_provider_arn => "dataProviderArn",
    :data_provider_identifier => "dataProviderIdentifier",
    :data_provider_name => "dataProviderName",
    :secrets_manager_access_role_arn => "secretsManagerAccessRoleArn",
    :secrets_manager_secret_id => "secretsManagerSecretId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



713
714
715
716
717
718
719
720
721
722
723
 
# File 'dms/cfn_migration_project.rb', line 713

def to_jsii
  result = {}
  result.merge!({
    "dataProviderArn" => @data_provider_arn,
    "dataProviderIdentifier" => @data_provider_identifier,
    "dataProviderName" => @data_provider_name,
    "secretsManagerAccessRoleArn" => @secrets_manager_access_role_arn,
    "secretsManagerSecretId" => @secrets_manager_secret_id,
  })
  result.compact
end