Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.DMS.ModifyEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the specified endpoint.

Synopsis

modifyEndpoint :: Text -> ModifyEndpoint
data ModifyEndpoint
meServerName :: Lens' ModifyEndpoint (Maybe Text)
meCertificateARN :: Lens' ModifyEndpoint (Maybe Text)
meServiceAccessRoleARN :: Lens' ModifyEndpoint (Maybe Text)
meExtraConnectionAttributes :: Lens' ModifyEndpoint (Maybe Text)
meEndpointType :: Lens' ModifyEndpoint (Maybe ReplicationEndpointTypeValue)
meUsername :: Lens' ModifyEndpoint (Maybe Text)
meExternalTableDefinition :: Lens' ModifyEndpoint (Maybe Text)
meEngineName :: Lens' ModifyEndpoint (Maybe Text)
meMongoDBSettings :: Lens' ModifyEndpoint (Maybe MongoDBSettings)
meSSLMode :: Lens' ModifyEndpoint (Maybe DmsSSLModeValue)
mePassword :: Lens' ModifyEndpoint (Maybe Text)
meDatabaseName :: Lens' ModifyEndpoint (Maybe Text)
meS3Settings :: Lens' ModifyEndpoint (Maybe S3Settings)
meEndpointIdentifier :: Lens' ModifyEndpoint (Maybe Text)
meDynamoDBSettings :: Lens' ModifyEndpoint (Maybe DynamoDBSettings)
mePort :: Lens' ModifyEndpoint (Maybe Int)
meEndpointARN :: Lens' ModifyEndpoint Text
modifyEndpointResponse :: Int -> ModifyEndpointResponse
data ModifyEndpointResponse
mersEndpoint :: Lens' ModifyEndpointResponse (Maybe Endpoint)
mersResponseStatus :: Lens' ModifyEndpointResponse Int

Creating a Request

modifyEndpoint Source #

Arguments

:: Text	`meEndpointARN`
-> ModifyEndpoint

Creates a value of ModifyEndpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

meServerName - The name of the server where the endpoint database resides.
meCertificateARN - The Amazon Resource Name (ARN) of the certificate used for SSL connection.
meServiceAccessRoleARN - The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
meExtraConnectionAttributes - Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
meEndpointType - The type of endpoint.
meUsername - The user name to be used to login to the endpoint database.
meExternalTableDefinition - The external table definition.
meEngineName - The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
meMongoDBSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service .
meSSLMode - The SSL mode to be used. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
mePassword - The password to be used to login to the endpoint database.
meDatabaseName - The name of the endpoint database.
meS3Settings - Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service .
meEndpointIdentifier - The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
meDynamoDBSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service .
mePort - The port used by the endpoint database.
meEndpointARN - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

data ModifyEndpoint Source #

See: modifyEndpoint smart constructor.

Instances

Eq ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods (==) :: ModifyEndpoint -> ModifyEndpoint -> Bool # (/=) :: ModifyEndpoint -> ModifyEndpoint -> Bool #
Data ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyEndpoint -> c ModifyEndpoint # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyEndpoint # toConstr :: ModifyEndpoint -> Constr # dataTypeOf :: ModifyEndpoint -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyEndpoint) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyEndpoint) # gmapT :: (forall b. Data b => b -> b) -> ModifyEndpoint -> ModifyEndpoint # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyEndpoint -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyEndpoint -> r # gmapQ :: (forall d. Data d => d -> u) -> ModifyEndpoint -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyEndpoint -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyEndpoint -> m ModifyEndpoint # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyEndpoint -> m ModifyEndpoint # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyEndpoint -> m ModifyEndpoint #
Show ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods showsPrec :: Int -> ModifyEndpoint -> ShowS # show :: ModifyEndpoint -> String # showList :: [ModifyEndpoint] -> ShowS #
Generic ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Associated Types type Rep ModifyEndpoint :: Type -> Type # Methods from :: ModifyEndpoint -> Rep ModifyEndpoint x # to :: Rep ModifyEndpoint x -> ModifyEndpoint #
Hashable ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods hashWithSalt :: Int -> ModifyEndpoint -> Int # hash :: ModifyEndpoint -> Int #
ToJSON ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods toJSON :: ModifyEndpoint -> Value # toEncoding :: ModifyEndpoint -> Encoding # toJSONList :: [ModifyEndpoint] -> Value # toEncodingList :: [ModifyEndpoint] -> Encoding #
AWSRequest ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Associated Types type Rs ModifyEndpoint :: Type # Methods request :: ModifyEndpoint -> Request ModifyEndpoint # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ModifyEndpoint -> ClientResponse -> m (Response ModifyEndpoint) #
ToHeaders ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods toHeaders :: ModifyEndpoint -> [Header] #
ToPath ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods toPath :: ModifyEndpoint -> ByteString #
ToQuery ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods toQuery :: ModifyEndpoint -> QueryString #
NFData ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods rnf :: ModifyEndpoint -> () #
type Rep ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint type Rep ModifyEndpoint = D1 (MetaData "ModifyEndpoint" "Network.AWS.DMS.ModifyEndpoint" "amazonka-dms-1.6.1-14neO3bVY9yK6uL0mC7eXy" False) (C1 (MetaCons "ModifyEndpoint'" PrefixI True) ((((S1 (MetaSel (Just "_meServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_meCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_meServiceAccessRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_meExtraConnectionAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_meEndpointType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReplicationEndpointTypeValue)) :: S1 (MetaSel (Just "_meUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_meExternalTableDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_meEngineName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 (MetaSel (Just "_meMongoDBSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MongoDBSettings)) :: S1 (MetaSel (Just "_meSSLMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DmsSSLModeValue))) :: (S1 (MetaSel (Just "_mePassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 (MetaSel (Just "_meDatabaseName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_meS3Settings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe S3Settings)) :: S1 (MetaSel (Just "_meEndpointIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_meDynamoDBSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DynamoDBSettings)) :: (S1 (MetaSel (Just "_mePort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :: S1 (MetaSel (Just "_meEndpointARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))
type Rs ModifyEndpoint Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint type Rs ModifyEndpoint = ModifyEndpointResponse

Request Lenses

meServerName :: Lens' ModifyEndpoint (Maybe Text) Source #

The name of the server where the endpoint database resides.

meCertificateARN :: Lens' ModifyEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

meServiceAccessRoleARN :: Lens' ModifyEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.

meExtraConnectionAttributes :: Lens' ModifyEndpoint (Maybe Text) Source #

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

meEndpointType :: Lens' ModifyEndpoint (Maybe ReplicationEndpointTypeValue) Source #

The type of endpoint.

meUsername :: Lens' ModifyEndpoint (Maybe Text) Source #

The user name to be used to login to the endpoint database.

meExternalTableDefinition :: Lens' ModifyEndpoint (Maybe Text) Source #

The external table definition.

meEngineName :: Lens' ModifyEndpoint (Maybe Text) Source #

The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

meMongoDBSettings :: Lens' ModifyEndpoint (Maybe MongoDBSettings) Source #

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service .

meSSLMode :: Lens' ModifyEndpoint (Maybe DmsSSLModeValue) Source #

The SSL mode to be used. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.

mePassword :: Lens' ModifyEndpoint (Maybe Text) Source #

The password to be used to login to the endpoint database.

meDatabaseName :: Lens' ModifyEndpoint (Maybe Text) Source #

The name of the endpoint database.

meS3Settings :: Lens' ModifyEndpoint (Maybe S3Settings) Source #

Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service .

meEndpointIdentifier :: Lens' ModifyEndpoint (Maybe Text) Source #

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

meDynamoDBSettings :: Lens' ModifyEndpoint (Maybe DynamoDBSettings) Source #

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service .

mePort :: Lens' ModifyEndpoint (Maybe Int) Source #

The port used by the endpoint database.

meEndpointARN :: Lens' ModifyEndpoint Text Source #

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Destructuring the Response

modifyEndpointResponse Source #

Arguments

:: Int	`mersResponseStatus`
-> ModifyEndpointResponse

Creates a value of ModifyEndpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mersEndpoint - The modified endpoint.
mersResponseStatus - -- | The response status code.

data ModifyEndpointResponse Source #

See: modifyEndpointResponse smart constructor.

Instances

Eq ModifyEndpointResponse Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods (==) :: ModifyEndpointResponse -> ModifyEndpointResponse -> Bool # (/=) :: ModifyEndpointResponse -> ModifyEndpointResponse -> Bool #
Data ModifyEndpointResponse Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyEndpointResponse -> c ModifyEndpointResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyEndpointResponse # toConstr :: ModifyEndpointResponse -> Constr # dataTypeOf :: ModifyEndpointResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyEndpointResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyEndpointResponse) # gmapT :: (forall b. Data b => b -> b) -> ModifyEndpointResponse -> ModifyEndpointResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyEndpointResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyEndpointResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ModifyEndpointResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyEndpointResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyEndpointResponse -> m ModifyEndpointResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyEndpointResponse -> m ModifyEndpointResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyEndpointResponse -> m ModifyEndpointResponse #
Show ModifyEndpointResponse Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods showsPrec :: Int -> ModifyEndpointResponse -> ShowS # show :: ModifyEndpointResponse -> String # showList :: [ModifyEndpointResponse] -> ShowS #
Generic ModifyEndpointResponse Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Associated Types type Rep ModifyEndpointResponse :: Type -> Type # Methods from :: ModifyEndpointResponse -> Rep ModifyEndpointResponse x # to :: Rep ModifyEndpointResponse x -> ModifyEndpointResponse #
NFData ModifyEndpointResponse Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint Methods rnf :: ModifyEndpointResponse -> () #
type Rep ModifyEndpointResponse Source #
Instance details Defined in Network.AWS.DMS.ModifyEndpoint type Rep ModifyEndpointResponse = D1 (MetaData "ModifyEndpointResponse" "Network.AWS.DMS.ModifyEndpoint" "amazonka-dms-1.6.1-14neO3bVY9yK6uL0mC7eXy" False) (C1 (MetaCons "ModifyEndpointResponse'" PrefixI True) (S1 (MetaSel (Just "_mersEndpoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Endpoint)) :*: S1 (MetaSel (Just "_mersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

mersEndpoint :: Lens' ModifyEndpointResponse (Maybe Endpoint) Source #

The modified endpoint.

mersResponseStatus :: Lens' ModifyEndpointResponse Int Source #

- | The response status code.