com.amazonaws.services.rds.model

Class StartExportTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.StartExportTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartExportTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartExportTaskRequest()

Method Summary

Modifier and Type	Method and Description
StartExportTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getExportOnly() The data to be exported from the snapshot or cluster.
String	getExportTaskIdentifier() A unique identifier for the export task.
String	getIamRoleArn() The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
String	getKmsKeyId() The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3.
String	getS3BucketName() The name of the Amazon S3 bucket to export the snapshot or cluster data to.
String	getS3Prefix() The Amazon S3 bucket prefix to use as the file name and path of the exported data.
String	getSourceArn() The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
int	hashCode()
void	setExportOnly(Collection<String> exportOnly) The data to be exported from the snapshot or cluster.
void	setExportTaskIdentifier(String exportTaskIdentifier) A unique identifier for the export task.
void	setIamRoleArn(String iamRoleArn) The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
void	setKmsKeyId(String kmsKeyId) The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3.
void	setS3BucketName(String s3BucketName) The name of the Amazon S3 bucket to export the snapshot or cluster data to.
void	setS3Prefix(String s3Prefix) The Amazon S3 bucket prefix to use as the file name and path of the exported data.
void	setSourceArn(String sourceArn) The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
String	toString() Returns a string representation of this object.
StartExportTaskRequest	withExportOnly(Collection<String> exportOnly) The data to be exported from the snapshot or cluster.
StartExportTaskRequest	withExportOnly(String... exportOnly) The data to be exported from the snapshot or cluster.
StartExportTaskRequest	withExportTaskIdentifier(String exportTaskIdentifier) A unique identifier for the export task.
StartExportTaskRequest	withIamRoleArn(String iamRoleArn) The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
StartExportTaskRequest	withKmsKeyId(String kmsKeyId) The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3.
StartExportTaskRequest	withS3BucketName(String s3BucketName) The name of the Amazon S3 bucket to export the snapshot or cluster data to.
StartExportTaskRequest	withS3Prefix(String s3Prefix) The Amazon S3 bucket prefix to use as the file name and path of the exported data.
StartExportTaskRequest	withSourceArn(String sourceArn) The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartExportTaskRequest

public StartExportTaskRequest()

Method Detail

setExportTaskIdentifier

public void setExportTaskIdentifier(String exportTaskIdentifier)

A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

Parameters:

exportTaskIdentifier - A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

getExportTaskIdentifier

public String getExportTaskIdentifier()

A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

Returns:

A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

withExportTaskIdentifier

public StartExportTaskRequest withExportTaskIdentifier(String exportTaskIdentifier)

A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

Parameters:

exportTaskIdentifier - A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceArn

public void setSourceArn(String sourceArn)

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

Parameters:

sourceArn - The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

getSourceArn

public String getSourceArn()

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

Returns:

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

withSourceArn

public StartExportTaskRequest withSourceArn(String sourceArn)

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

Parameters:

sourceArn - The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3BucketName

public void setS3BucketName(String s3BucketName)

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

Parameters:

s3BucketName - The name of the Amazon S3 bucket to export the snapshot or cluster data to.

getS3BucketName

public String getS3BucketName()

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

Returns:

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

withS3BucketName

public StartExportTaskRequest withS3BucketName(String s3BucketName)

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

Parameters:

s3BucketName - The name of the Amazon S3 bucket to export the snapshot or cluster data to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIamRoleArn

public void setIamRoleArn(String iamRoleArn)

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

• s3:PutObject*

• s3:GetObject*

• s3:ListBucket

• s3:DeleteObject*

• s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

• arn:aws:s3:::your-s3-bucket

• arn:aws:s3:::your-s3-bucket/*

Parameters:

iamRoleArn - The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

• s3:PutObject*

• s3:GetObject*

• s3:ListBucket

• s3:DeleteObject*

• s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

• arn:aws:s3:::your-s3-bucket

• arn:aws:s3:::your-s3-bucket/*

getIamRoleArn

public String getIamRoleArn()

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

• s3:PutObject*

• s3:GetObject*

• s3:ListBucket

• s3:DeleteObject*

• s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

• arn:aws:s3:::your-s3-bucket

• arn:aws:s3:::your-s3-bucket/*

Returns:

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

• s3:PutObject*

• s3:GetObject*

• s3:ListBucket

• s3:DeleteObject*

• s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

• arn:aws:s3:::your-s3-bucket

• arn:aws:s3:::your-s3-bucket/*

withIamRoleArn

public StartExportTaskRequest withIamRoleArn(String iamRoleArn)

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

• s3:PutObject*

• s3:GetObject*

• s3:ListBucket

• s3:DeleteObject*

• s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

• arn:aws:s3:::your-s3-bucket

• arn:aws:s3:::your-s3-bucket/*

Parameters:

iamRoleArn - The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

• s3:PutObject*

• s3:GetObject*

• s3:ListBucket

• s3:DeleteObject*

• s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

• arn:aws:s3:::your-s3-bucket

• arn:aws:s3:::your-s3-bucket/*

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

• kms:Encrypt

• kms:Decrypt

• kms:GenerateDataKey

• kms:GenerateDataKeyWithoutPlaintext

• kms:ReEncryptFrom

• kms:ReEncryptTo

• kms:CreateGrant

• kms:DescribeKey

• kms:RetireGrant

Parameters:

kmsKeyId - The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

• kms:Encrypt

• kms:Decrypt

• kms:GenerateDataKey

• kms:GenerateDataKeyWithoutPlaintext

• kms:ReEncryptFrom

• kms:ReEncryptTo

• kms:CreateGrant

• kms:DescribeKey

• kms:RetireGrant

getKmsKeyId

public String getKmsKeyId()

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

• kms:Encrypt

• kms:Decrypt

• kms:GenerateDataKey

• kms:GenerateDataKeyWithoutPlaintext

• kms:ReEncryptFrom

• kms:ReEncryptTo

• kms:CreateGrant

• kms:DescribeKey

• kms:RetireGrant

Returns:

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

• kms:Encrypt

• kms:Decrypt

• kms:GenerateDataKey

• kms:GenerateDataKeyWithoutPlaintext

• kms:ReEncryptFrom

• kms:ReEncryptTo

• kms:CreateGrant

• kms:DescribeKey

• kms:RetireGrant

withKmsKeyId

public StartExportTaskRequest withKmsKeyId(String kmsKeyId)

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

• kms:Encrypt

• kms:Decrypt

• kms:GenerateDataKey

• kms:GenerateDataKeyWithoutPlaintext

• kms:ReEncryptFrom

• kms:ReEncryptTo

• kms:CreateGrant

• kms:DescribeKey

• kms:RetireGrant

Parameters:

kmsKeyId - The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

• kms:Encrypt

• kms:Decrypt

• kms:GenerateDataKey

• kms:GenerateDataKeyWithoutPlaintext

• kms:ReEncryptFrom

• kms:ReEncryptTo

• kms:CreateGrant

• kms:DescribeKey

• kms:RetireGrant

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3Prefix

public void setS3Prefix(String s3Prefix)

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

Parameters:

s3Prefix - The Amazon S3 bucket prefix to use as the file name and path of the exported data.

getS3Prefix

public String getS3Prefix()

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

Returns:

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

withS3Prefix

public StartExportTaskRequest withS3Prefix(String s3Prefix)

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

Parameters:

s3Prefix - The Amazon S3 bucket prefix to use as the file name and path of the exported data.

Returns:

Returns a reference to this object so that method calls can be chained together.

getExportOnly

public List<String> getExportOnly()

The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Returns:

The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

setExportOnly

public void setExportOnly(Collection<String> exportOnly)

The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Parameters:

exportOnly - The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

withExportOnly

public StartExportTaskRequest withExportOnly(String... exportOnly)

The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

NOTE: This method appends the values to the existing list (if any). Use setExportOnly(java.util.Collection) or withExportOnly(java.util.Collection) if you want to override the existing values.

Parameters:

exportOnly - The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Returns:

Returns a reference to this object so that method calls can be chained together.

withExportOnly

public StartExportTaskRequest withExportOnly(Collection<String> exportOnly)

The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Parameters:

exportOnly - The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

Valid Values:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartExportTaskRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()