/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::DMS::DocDbSettings

NAME

Paws::DMS::DocDbSettings

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::DMS::DocDbSettings object:

$service_obj->Method(Att1 => { DatabaseName => $value, ..., Username => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::DocDbSettings object:

$result = $service_obj->Method(...);
$result->Att1->DatabaseName

DESCRIPTION

Provides information that defines a DocumentDB endpoint.

ATTRIBUTES

DatabaseName => Str

The database name on the DocumentDB source endpoint.

DocsToInvestigate => Int

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".

Must be a positive value greater than 0. Default value is 1000.

ExtractDocId => Bool

Specifies the document ID. Use this setting when NestingLevel is set to "none".

Default value is "false".

KmsKeyId => Str

The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

NestingLevel => Str

Specifies either document or table mode.

Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.

Password => Str

The password for the user account you use to access the DocumentDB source endpoint.

Port => Int

The port value for the DocumentDB source endpoint.

SecretsManagerAccessRoleArn => Str

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB 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 AWS Database Migration Service resources (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide.

SecretsManagerSecretId => Str

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

ServerName => Str

The name of the server on the DocumentDB source endpoint.

Username => Str

The user name you use to access the DocumentDB source endpoint.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::DMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues