Network.AWS.DMS.CreateEndpoint

Creates an endpoint using the provided settings.

Creating a Request

createEndpoint

Arguments

:: Text

ceEndpointIdentifier

-> ReplicationEndpointTypeValue

ceEndpointType

-> Text

ceEngineName

-> CreateEndpoint

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

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

• ceServerName - The name of the server where the endpoint database resides.
• ceCertificateARN - The Amazon Resource Name (ARN) for the certificate.
• ceServiceAccessRoleARN - The Amazon Resource Name (ARN) for the service access role you want to use to create the endpoint.
• ceExtraConnectionAttributes - Additional attributes associated with the connection.
• ceUsername - The user name to be used to login to the endpoint database.
• ceExternalTableDefinition - The external table definition.
• ceKMSKeyId - The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
• ceMongoDBSettings - 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 .
• ceSSLMode - The SSL mode to use for the SSL connection. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
• cePassword - The password to be used to login to the endpoint database.
• ceDatabaseName - The name of the endpoint database.
• ceS3Settings - Settings in JSON format for the target Amazon 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 .
• ceDynamoDBSettings - 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 .
• ceTags - Tags to be added to the endpoint.
• cePort - The port used by the endpoint database.
• ceEndpointIdentifier - 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.
• ceEndpointType - The type of endpoint.
• ceEngineName - 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, dynamodb, mongodb, and sqlserver.

data CreateEndpoint

See: createEndpoint smart constructor.

Instances

Eq CreateEndpoint

Methods

(==) :: CreateEndpoint -> CreateEndpoint -> Bool

(/=) :: CreateEndpoint -> CreateEndpoint -> Bool

Data CreateEndpoint

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEndpoint -> c CreateEndpoint

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEndpoint

toConstr :: CreateEndpoint -> Constr

dataTypeOf :: CreateEndpoint -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateEndpoint)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEndpoint)

gmapT :: (forall b. Data b => b -> b) -> CreateEndpoint -> CreateEndpoint

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEndpoint -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEndpoint -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateEndpoint -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEndpoint -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEndpoint -> m CreateEndpoint

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEndpoint -> m CreateEndpoint

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEndpoint -> m CreateEndpoint

Show CreateEndpoint

Methods

showsPrec :: Int -> CreateEndpoint -> ShowS

show :: CreateEndpoint -> String

showList :: [CreateEndpoint] -> ShowS

Generic CreateEndpoint

Associated Types

type Rep CreateEndpoint :: * -> *

Methods

from :: CreateEndpoint -> Rep CreateEndpoint x

to :: Rep CreateEndpoint x -> CreateEndpoint

Hashable CreateEndpoint

Methods

hashWithSalt :: Int -> CreateEndpoint -> Int

hash :: CreateEndpoint -> Int

ToJSON CreateEndpoint

Methods

toJSON :: CreateEndpoint -> Value

toEncoding :: CreateEndpoint -> Encoding

toJSONList :: [CreateEndpoint] -> Value

toEncodingList :: [CreateEndpoint] -> Encoding

NFData CreateEndpoint

Methods

rnf :: CreateEndpoint -> ()

AWSRequest CreateEndpoint

Associated Types

type Rs CreateEndpoint :: *

Methods

request :: CreateEndpoint -> Request CreateEndpoint

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateEndpoint -> ClientResponse -> m (Response CreateEndpoint)

ToHeaders CreateEndpoint

Methods

toHeaders :: CreateEndpoint -> [Header]

ToPath CreateEndpoint

Methods

toPath :: CreateEndpoint -> ByteString

ToQuery CreateEndpoint

Methods

toQuery :: CreateEndpoint -> QueryString

type Rep CreateEndpoint

type Rep CreateEndpoint = D1 * (MetaData "CreateEndpoint" "Network.AWS.DMS.CreateEndpoint" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "CreateEndpoint'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ceServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ceCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ceServiceAccessRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ceExtraConnectionAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ceUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ceExternalTableDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ceKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ceMongoDBSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MongoDBSettings))) (S1 * (MetaSel (Just Symbol "_ceSSLMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DmsSSLModeValue))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cePassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) (S1 * (MetaSel (Just Symbol "_ceDatabaseName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ceS3Settings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe S3Settings))) (S1 * (MetaSel (Just Symbol "_ceDynamoDBSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DynamoDBSettings))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ceTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag]))) (S1 * (MetaSel (Just Symbol "_cePort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ceEndpointIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_ceEndpointType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ReplicationEndpointTypeValue)) (S1 * (MetaSel (Just Symbol "_ceEngineName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))))

type Rs CreateEndpoint

type Rs CreateEndpoint = CreateEndpointResponse

Request Lenses

ceServerName :: Lens' CreateEndpoint (Maybe Text)

The name of the server where the endpoint database resides.

ceCertificateARN :: Lens' CreateEndpoint (Maybe Text)

The Amazon Resource Name (ARN) for the certificate.

ceServiceAccessRoleARN :: Lens' CreateEndpoint (Maybe Text)

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

ceExtraConnectionAttributes :: Lens' CreateEndpoint (Maybe Text)

Additional attributes associated with the connection.

ceUsername :: Lens' CreateEndpoint (Maybe Text)

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

ceExternalTableDefinition :: Lens' CreateEndpoint (Maybe Text)

The external table definition.

ceKMSKeyId :: Lens' CreateEndpoint (Maybe Text)

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

ceMongoDBSettings :: Lens' CreateEndpoint (Maybe MongoDBSettings)

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 .

ceSSLMode :: Lens' CreateEndpoint (Maybe DmsSSLModeValue)

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

cePassword :: Lens' CreateEndpoint (Maybe Text)

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

ceDatabaseName :: Lens' CreateEndpoint (Maybe Text)

The name of the endpoint database.

ceS3Settings :: Lens' CreateEndpoint (Maybe S3Settings)

Settings in JSON format for the target Amazon 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 .

ceDynamoDBSettings :: Lens' CreateEndpoint (Maybe DynamoDBSettings)

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 .

ceTags :: Lens' CreateEndpoint [Tag]

Tags to be added to the endpoint.

cePort :: Lens' CreateEndpoint (Maybe Int)

The port used by the endpoint database.

ceEndpointIdentifier :: Lens' CreateEndpoint Text

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.

ceEndpointType :: Lens' CreateEndpoint ReplicationEndpointTypeValue

The type of endpoint.

ceEngineName :: Lens' CreateEndpoint Text

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, dynamodb, mongodb, and sqlserver.

Destructuring the Response

createEndpointResponse

Arguments

:: Int

cersResponseStatus

-> CreateEndpointResponse

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

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

• cersEndpoint - The endpoint that was created.
• cersResponseStatus - -- | The response status code.

data CreateEndpointResponse

See: createEndpointResponse smart constructor.

Instances

Eq CreateEndpointResponse

Methods

(==) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool

(/=) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool

Data CreateEndpointResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEndpointResponse -> c CreateEndpointResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEndpointResponse

toConstr :: CreateEndpointResponse -> Constr

dataTypeOf :: CreateEndpointResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateEndpointResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEndpointResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateEndpointResponse -> CreateEndpointResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEndpointResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEndpointResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateEndpointResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEndpointResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEndpointResponse -> m CreateEndpointResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEndpointResponse -> m CreateEndpointResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEndpointResponse -> m CreateEndpointResponse

Show CreateEndpointResponse

Methods

showsPrec :: Int -> CreateEndpointResponse -> ShowS

show :: CreateEndpointResponse -> String

showList :: [CreateEndpointResponse] -> ShowS

Generic CreateEndpointResponse

Associated Types

type Rep CreateEndpointResponse :: * -> *

Methods

from :: CreateEndpointResponse -> Rep CreateEndpointResponse x

to :: Rep CreateEndpointResponse x -> CreateEndpointResponse

NFData CreateEndpointResponse

Methods

rnf :: CreateEndpointResponse -> ()

type Rep CreateEndpointResponse

type Rep CreateEndpointResponse = D1 * (MetaData "CreateEndpointResponse" "Network.AWS.DMS.CreateEndpoint" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "CreateEndpointResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cersEndpoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Endpoint))) (S1 * (MetaSel (Just Symbol "_cersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cersEndpoint :: Lens' CreateEndpointResponse (Maybe Endpoint)

The endpoint that was created.

cersResponseStatus :: Lens' CreateEndpointResponse Int

• - | The response status code.