Class: Aws::DatabaseMigrationService::Types::RedisSettings

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::RedisSettings

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

Provides information that defines a Redis target endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:auth_password]

Instance Attribute Summary

• #auth_password ⇒ String

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

• #auth_type ⇒ String

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

• #auth_user_name ⇒ String

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

• #port ⇒ Integer

  Transmission Control Protocol (TCP) port for the endpoint.

• #server_name ⇒ String

  Fully qualified domain name of the endpoint.

• #ssl_ca_certificate_arn ⇒ String

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

• #ssl_security_protocol ⇒ String

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

Instance Attribute Details

#auth_password ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end

#auth_type ⇒ String

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end

#auth_user_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end

#port ⇒ Integer

Transmission Control Protocol (TCP) port for the endpoint.

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end

#server_name ⇒ String

Fully qualified domain name of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end

#ssl_ca_certificate_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end

#ssl_security_protocol ⇒ String

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 10239

class RedisSettings < Struct.new(
  :server_name,
  :port,
  :ssl_security_protocol,
  :auth_type,
  :auth_user_name,
  :auth_password,
  :ssl_ca_certificate_arn)
  SENSITIVE = [:auth_password]
  include Aws::Structure
end