Class: AWSCDK::DMS::CfnEndpoint::RedisSettingsProperty

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

Overview

Provides information that defines a Redis target endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_password: nil, auth_type: nil, auth_user_name: nil, port: nil, server_name: nil, ssl_ca_certificate_arn: nil, ssl_security_protocol: nil) ⇒ RedisSettingsProperty

Returns a new instance of RedisSettingsProperty.

Parameters:

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

    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

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

    The type of authentication to perform when connecting to a Redis target.

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

    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

  • port (Numeric, nil) (defaults to: nil) —

    Transmission Control Protocol (TCP) port for the endpoint.

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

    Fully qualified domain name of the endpoint.

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

    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

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

    The connection to a Redis target endpoint using Transport Layer Security (TLS).



3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'dms/cfn_endpoint.rb', line 3168

def initialize(auth_password: nil, auth_type: nil, auth_user_name: nil, port: nil, server_name: nil, ssl_ca_certificate_arn: nil, ssl_security_protocol: nil)
  @auth_password = auth_password
  Jsii::Type.check_type(@auth_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authPassword") unless @auth_password.nil?
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authType") unless @auth_type.nil?
  @auth_user_name = auth_user_name
  Jsii::Type.check_type(@auth_user_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authUserName") unless @auth_user_name.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @server_name = server_name
  Jsii::Type.check_type(@server_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverName") unless @server_name.nil?
  @ssl_ca_certificate_arn = ssl_ca_certificate_arn
  Jsii::Type.check_type(@ssl_ca_certificate_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sslCaCertificateArn") unless @ssl_ca_certificate_arn.nil?
  @ssl_security_protocol = ssl_security_protocol
  Jsii::Type.check_type(@ssl_security_protocol, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sslSecurityProtocol") unless @ssl_security_protocol.nil?
end

Instance Attribute Details

#auth_password ⇒ String? (readonly)

The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

Returns:

  • (String, nil)

See Also:



3189
3190
3191
 
# File 'dms/cfn_endpoint.rb', line 3189

def auth_password
  @auth_password
end

#auth_type ⇒ String? (readonly)

The type of authentication to perform when connecting to a Redis target.

Options include none , auth-token , and auth-role . The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.

Returns:

  • (String, nil)

See Also:



3196
3197
3198
 
# File 'dms/cfn_endpoint.rb', line 3196

def auth_type
  @auth_type
end

#auth_user_name ⇒ String? (readonly)

The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

Returns:

  • (String, nil)

See Also:



3201
3202
3203
 
# File 'dms/cfn_endpoint.rb', line 3201

def auth_user_name
  @auth_user_name
end

#port ⇒ Numeric? (readonly)

Transmission Control Protocol (TCP) port for the endpoint.

Returns:

  • (Numeric, nil)

See Also:



3206
3207
3208
 
# File 'dms/cfn_endpoint.rb', line 3206

def port
  @port
end

#server_name ⇒ String? (readonly)

Fully qualified domain name of the endpoint.

Returns:

  • (String, nil)

See Also:



3211
3212
3213
 
# File 'dms/cfn_endpoint.rb', line 3211

def server_name
  @server_name
end

#ssl_ca_certificate_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

Returns:

  • (String, nil)

See Also:



3216
3217
3218
 
# File 'dms/cfn_endpoint.rb', line 3216

def ssl_ca_certificate_arn
  @ssl_ca_certificate_arn
end

#ssl_security_protocol ⇒ String? (readonly)

The connection to a Redis target endpoint using Transport Layer Security (TLS).

Valid values include plaintext and ssl-encryption . The default is ssl-encryption . The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.

The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

Returns:

  • (String, nil)

See Also:



3225
3226
3227
 
# File 'dms/cfn_endpoint.rb', line 3225

def ssl_security_protocol
  @ssl_security_protocol
end

Class Method Details

.jsii_properties ⇒ Object 



3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
 
# File 'dms/cfn_endpoint.rb', line 3227

def self.jsii_properties
  {
    :auth_password => "authPassword",
    :auth_type => "authType",
    :auth_user_name => "authUserName",
    :port => "port",
    :server_name => "serverName",
    :ssl_ca_certificate_arn => "sslCaCertificateArn",
    :ssl_security_protocol => "sslSecurityProtocol",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
 
# File 'dms/cfn_endpoint.rb', line 3239

def to_jsii
  result = {}
  result.merge!({
    "authPassword" => @auth_password,
    "authType" => @auth_type,
    "authUserName" => @auth_user_name,
    "port" => @port,
    "serverName" => @server_name,
    "sslCaCertificateArn" => @ssl_ca_certificate_arn,
    "sslSecurityProtocol" => @ssl_security_protocol,
  })
  result.compact
end