AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the ModifyEndpoint operation against AWS Database Migration Service.

Syntax

Edit-DMSEndpoint
-EndpointArn <String>
-MongoDbSettings_AuthMechanism <AuthMechanismValue>
-MongoDbSettings_AuthSource <String>
-MongoDbSettings_AuthType <AuthTypeValue>
-S3Settings_BucketFolder <String>
-S3Settings_BucketName <String>
-CertificateArn <String>
-S3Settings_CompressionType <CompressionTypeValue>
-S3Settings_CsvDelimiter <String>
-S3Settings_CsvRowDelimiter <String>
-DatabaseName <String>
-MongoDbSettings_DatabaseName <String>
-MongoDbSettings_DocsToInvestigate <String>
-EndpointIdentifier <String>
-EndpointType <ReplicationEndpointTypeValue>
-EngineName <String>
-S3Settings_ExternalTableDefinition <String>
-ExtraConnectionAttribute <String>
-MongoDbSettings_ExtractDocId <String>
-MongoDbSettings_NestingLevel <NestingLevelValue>
-MongoDbSettings_Password <String>
-Password <String>
-MongoDbSettings_Port <Int32>
-Port <Int32>
-MongoDbSettings_ServerName <String>
-ServerName <String>
-DynamoDbSettings_ServiceAccessRoleArn <String>
-S3Settings_ServiceAccessRoleArn <String>
-SslMode <DmsSslModeValue>
-MongoDbSettings_Username <String>
-Username <String>
-Force <SwitchParameter>

Description

Modifies the specified endpoint.

Parameters

-CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?False
-DatabaseName <String>
The name of the endpoint database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DynamoDbSettings_ServiceAccessRoleArn <String>
The Amazon Resource Name (ARN) used by the service access IAM role.
Required?False
Position?Named
Accept pipeline input?False
-EndpointArn <String>
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointIdentifier <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
The type of endpoint.
Required?False
Position?Named
Accept pipeline input?False
-EngineName <String>
The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, DYNAMODB, MONGODB, SYBASE, and SQLSERVER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExtraConnectionAttribute <String>
Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_AuthMechanism <AuthMechanismValue>
The authentication mechanism you use to access the MongoDB source endpoint.Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_AuthSource <String>
The MongoDB database name. This attribute is not used when authType=NO.The default is admin.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_AuthType <AuthTypeValue>
The authentication type you use to access the MongoDB source endpoint.Valid values: NO, PASSWORD When NO is selected, user name and password parameters are not used and can be empty.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_DatabaseName <String>
The database name on the MongoDB source endpoint.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_DocsToInvestigate <String>
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE. Must be a positive value greater than 0. Default value is 1000.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_ExtractDocId <String>
Specifies the document ID. Use this attribute when NestingLevel is set to NONE. Default value is false.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_NestingLevel <NestingLevelValue>
Specifies either document or table mode. Valid values: NONE, ONEDefault value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_Password <String>
The password for the user account you use to access the MongoDB source endpoint.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_Port <Int32>
The port value for the MongoDB source endpoint.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_ServerName <String>
The name of the server on the MongoDB source endpoint.
Required?False
Position?Named
Accept pipeline input?False
-MongoDbSettings_Username <String>
The user name you use to access the MongoDB source endpoint.
Required?False
Position?Named
Accept pipeline input?False
-Password <String>
The password to be used to login to the endpoint database.
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port used by the endpoint database.
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_BucketFolder <String>
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_BucketName <String>
The name of the S3 bucket.
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_CompressionType <CompressionTypeValue>
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_CsvDelimiter <String>
The delimiter used to separate columns in the source files. The default is a comma.
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_CsvRowDelimiter <String>
The delimiter used to separate rows in the source files. The default is a carriage return (\n).
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_ExternalTableDefinition <String>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-S3Settings_ServiceAccessRoleArn <String>
The Amazon Resource Name (ARN) used by the service access IAM role.
Required?False
Position?Named
Accept pipeline input?False
-ServerName <String>
The name of the server where the endpoint database resides.
Required?False
Position?Named
Accept pipeline input?False
-SslMode <DmsSslModeValue>
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.
Required?False
Position?Named
Accept pipeline input?False
-Username <String>
The user name to be used to login to the endpoint database.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the EndpointArn parameter.

Outputs

This cmdlet returns a Endpoint object. The service call response (type Amazon.DatabaseMigrationService.Model.ModifyEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z