Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.Types.SybaseSettings

Description

Documentation

data SybaseSettings Source #

Provides information that defines a SAP ASE endpoint.

See: newSybaseSettings smart constructor.

Constructors

SybaseSettings'

Fields

databaseName :: Maybe Text
Database name for the endpoint.
password :: Maybe (Sensitive Text)
Endpoint connection password.
port :: Maybe Int
Endpoint TCP port. The default is 5000.
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.
secretsManagerSecretId :: Maybe Text
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
serverName :: Maybe Text
Fully qualified domain name of the endpoint.
username :: Maybe Text
Endpoint connection user name.

Instances

Instances details

FromJSON SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Methods parseJSON :: Value -> Parser SybaseSettings # parseJSONList :: Value -> Parser [SybaseSettings] #
ToJSON SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Methods toJSON :: SybaseSettings -> Value # toEncoding :: SybaseSettings -> Encoding # toJSONList :: [SybaseSettings] -> Value # toEncodingList :: [SybaseSettings] -> Encoding #
Generic SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Associated Types type Rep SybaseSettings :: Type -> Type # Methods from :: SybaseSettings -> Rep SybaseSettings x # to :: Rep SybaseSettings x -> SybaseSettings #
Show SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Methods showsPrec :: Int -> SybaseSettings -> ShowS # show :: SybaseSettings -> String # showList :: [SybaseSettings] -> ShowS #
NFData SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Methods rnf :: SybaseSettings -> () #
Eq SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Methods (==) :: SybaseSettings -> SybaseSettings -> Bool # (/=) :: SybaseSettings -> SybaseSettings -> Bool #
Hashable SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings Methods hashWithSalt :: Int -> SybaseSettings -> Int # hash :: SybaseSettings -> Int #
type Rep SybaseSettings Source #
Instance details Defined in Amazonka.DMS.Types.SybaseSettings type Rep SybaseSettings = D1 ('MetaData "SybaseSettings" "Amazonka.DMS.Types.SybaseSettings" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "SybaseSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "secretsManagerAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretsManagerSecretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:databaseName:SybaseSettings', sybaseSettings_databaseName - Database name for the endpoint.

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

$sel:port:SybaseSettings', sybaseSettings_port - Endpoint TCP port. The default is 5000.

$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:secretsManagerSecretId:SybaseSettings', sybaseSettings_secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

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

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

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

Database name for the endpoint.

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

Endpoint connection password.

sybaseSettings_port :: Lens' SybaseSettings (Maybe Int) Source #

Endpoint TCP port. The default is 5000.

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_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.

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

Fully qualified domain name of the endpoint.

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

Endpoint connection user name.