libZSservicesZSamazonka-dmsZSamazonka-dms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DMS.Types.SybaseSettings

Description

 
Synopsis

Documentation

data SybaseSettings Source #

Provides information that defines a SAP ASE endpoint.

See: newSybaseSettings smart constructor.

Constructors

SybaseSettings' 

Fields

  • serverName :: Maybe Text

    Fully qualified domain name of the endpoint.

  • secretsManagerAccessRoleArn :: Maybe Text

    The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.

    You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

  • username :: Maybe Text

    Endpoint connection user name.

  • password :: Maybe (Sensitive Text)

    Endpoint connection password.

  • databaseName :: Maybe Text

    Database name for the endpoint.

  • secretsManagerSecretId :: Maybe Text

    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

  • port :: Maybe Int

    Endpoint TCP port.

Instances

Instances details
Eq SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

Show SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

Generic SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

Associated Types

type Rep SybaseSettings :: Type -> Type #

NFData SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

Methods

rnf :: SybaseSettings -> () #

Hashable SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

ToJSON SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

FromJSON SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

type Rep SybaseSettings Source # 
Instance details

Defined in Amazonka.DMS.Types.SybaseSettings

type Rep SybaseSettings = D1 ('MetaData "SybaseSettings" "Amazonka.DMS.Types.SybaseSettings" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "SybaseSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "secretsManagerAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "secretsManagerSecretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newSybaseSettings :: SybaseSettings Source #

Create a value of SybaseSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serverName:SybaseSettings', sybaseSettings_serverName - Fully qualified domain name of the endpoint.

$sel:secretsManagerAccessRoleArn:SybaseSettings', sybaseSettings_secretsManagerAccessRoleArn - The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

$sel:username:SybaseSettings', sybaseSettings_username - Endpoint connection user name.

$sel:password:SybaseSettings', sybaseSettings_password - Endpoint connection password.

$sel:databaseName:SybaseSettings', sybaseSettings_databaseName - Database name for the endpoint.

$sel:secretsManagerSecretId:SybaseSettings', sybaseSettings_secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

$sel:port:SybaseSettings', sybaseSettings_port - Endpoint TCP port.

sybaseSettings_serverName :: Lens' SybaseSettings (Maybe Text) Source #

Fully qualified domain name of the endpoint.

sybaseSettings_secretsManagerAccessRoleArn :: Lens' SybaseSettings (Maybe Text) Source #

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

sybaseSettings_username :: Lens' SybaseSettings (Maybe Text) Source #

Endpoint connection user name.

sybaseSettings_password :: Lens' SybaseSettings (Maybe Text) Source #

Endpoint connection password.

sybaseSettings_databaseName :: Lens' SybaseSettings (Maybe Text) Source #

Database name for the endpoint.

sybaseSettings_secretsManagerSecretId :: Lens' SybaseSettings (Maybe Text) Source #

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.