software.amazon.awssdk.services.rds.model.CopyDbSnapshotRequest Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CopyDbSnapshotRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField SOURCE_DB_SNAPSHOT_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.getter(getter(CopyDbSnapshotRequest::sourceDBSnapshotIdentifier))
.setter(setter(Builder::sourceDBSnapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceDBSnapshotIdentifier").build())
.build();
private static final SdkField TARGET_DB_SNAPSHOT_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.getter(getter(CopyDbSnapshotRequest::targetDBSnapshotIdentifier))
.setter(setter(Builder::targetDBSnapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetDBSnapshotIdentifier").build())
.build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopyDbSnapshotRequest::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(CopyDbSnapshotRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName("Tag")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Tag").build()).build()).build()).build();
private static final SdkField COPY_TAGS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(CopyDbSnapshotRequest::copyTags)).setter(setter(Builder::copyTags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CopyTags").build()).build();
private static final SdkField PRE_SIGNED_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopyDbSnapshotRequest::preSignedUrl)).setter(setter(Builder::preSignedUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PreSignedUrl").build()).build();
private static final SdkField OPTION_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopyDbSnapshotRequest::optionGroupName)).setter(setter(Builder::optionGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OptionGroupName").build()).build();
private static final SdkField SOURCE_REGION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CopyDbSnapshotRequest::sourceRegion)).setter(setter(Builder::sourceRegion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceRegion").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
SOURCE_DB_SNAPSHOT_IDENTIFIER_FIELD, TARGET_DB_SNAPSHOT_IDENTIFIER_FIELD, KMS_KEY_ID_FIELD, TAGS_FIELD,
COPY_TAGS_FIELD, PRE_SIGNED_URL_FIELD, OPTION_GROUP_NAME_FIELD, SOURCE_REGION_FIELD));
private final String sourceDBSnapshotIdentifier;
private final String targetDBSnapshotIdentifier;
private final String kmsKeyId;
private final List tags;
private final Boolean copyTags;
private final String preSignedUrl;
private final String optionGroupName;
private final String sourceRegion;
private CopyDbSnapshotRequest(BuilderImpl builder) {
super(builder);
this.sourceDBSnapshotIdentifier = builder.sourceDBSnapshotIdentifier;
this.targetDBSnapshotIdentifier = builder.targetDBSnapshotIdentifier;
this.kmsKeyId = builder.kmsKeyId;
this.tags = builder.tags;
this.copyTags = builder.copyTags;
this.preSignedUrl = builder.preSignedUrl;
this.optionGroupName = builder.optionGroupName;
this.sourceRegion = builder.sourceRegion;
}
/**
*
* The identifier for the source DB snapshot.
*
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
* you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the
* shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
* must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*
*
* @return The identifier for the source DB snapshot.
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For
* example, you might specify
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name
* (ARN) of the shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS
* Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl
* parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*/
public String sourceDBSnapshotIdentifier() {
return sourceDBSnapshotIdentifier;
}
/**
*
* The identifier for the copy of the snapshot.
*
*
* Constraints:
*
*
* -
*
* Can't be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*
*
* @return The identifier for the copy of the snapshot.
*
* Constraints:
*
*
* -
*
* Can't be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*/
public String targetDBSnapshotIdentifier() {
return targetDBSnapshotIdentifier;
}
/**
*
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt
* the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB
* snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for
* this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination
* AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use
* encryption keys from one AWS Region in another AWS Region.
*
*
* @return The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS
* key identifier, or the KMS key alias for the KMS encryption key.
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to
* encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the
* copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a
* value for this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the
* destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and
* you can't use encryption keys from one AWS Region in another AWS Region.
*/
public String kmsKeyId() {
return kmsKeyId;
}
/**
* Returns the value of the Tags property for this object.
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return The value of the Tags property for this object.
*/
public List tags() {
return tags;
}
/**
*
* A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By
* default, tags are not copied.
*
*
* @return A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By
* default, tags are not copied.
*/
public Boolean copyTags() {
return copyTags;
}
/**
*
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
* source AWS Region that contains the source DB snapshot to copy.
*
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
* Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy
* an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
* the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
* contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
* the same one where the CopyDBSnapshot action is called that contains this presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
* you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that
* contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the
* DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
* the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is
* called in the destination AWS Region, and the action contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied.
* This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
* are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests:
* Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*
* @return The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action
* in the source AWS Region that contains the source DB snapshot to copy.
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using
* the Amazon RDS API. You can specify the --source-region option instead of this parameter
* when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be
* executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL
* request must contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS
* Region is the same one where the CopyDBSnapshot action is called that contains this
* presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS
* Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a
* presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region.
* For this example, the DestinationRegion in the presigned URL must be set to the us-east-1
* AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB
* snapshot in the destination AWS Region. This is the same identifier for both the
* CopyDBSnapshot action that is called in the destination AWS Region, and the action contained
* in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
* example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating
* Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*/
public String preSignedUrl() {
return preSignedUrl;
}
/**
*
* The name of an option group to associate with the copy of the snapshot.
*
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a
* nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL
* Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.
*
*
* @return The name of an option group to associate with the copy of the snapshot.
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance
* uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or
* Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information,
* see Option Group Considerations in the Amazon RDS User Guide.
*/
public String optionGroupName() {
return optionGroupName;
}
/**
* The region where the source snapshot is located.
*
* @return The region where the source snapshot is located.
*/
public String sourceRegion() {
return sourceRegion;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(sourceDBSnapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(targetDBSnapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(tags());
hashCode = 31 * hashCode + Objects.hashCode(copyTags());
hashCode = 31 * hashCode + Objects.hashCode(preSignedUrl());
hashCode = 31 * hashCode + Objects.hashCode(optionGroupName());
hashCode = 31 * hashCode + Objects.hashCode(sourceRegion());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CopyDbSnapshotRequest)) {
return false;
}
CopyDbSnapshotRequest other = (CopyDbSnapshotRequest) obj;
return Objects.equals(sourceDBSnapshotIdentifier(), other.sourceDBSnapshotIdentifier())
&& Objects.equals(targetDBSnapshotIdentifier(), other.targetDBSnapshotIdentifier())
&& Objects.equals(kmsKeyId(), other.kmsKeyId()) && Objects.equals(tags(), other.tags())
&& Objects.equals(copyTags(), other.copyTags()) && Objects.equals(preSignedUrl(), other.preSignedUrl())
&& Objects.equals(optionGroupName(), other.optionGroupName())
&& Objects.equals(sourceRegion(), other.sourceRegion());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("CopyDbSnapshotRequest").add("SourceDBSnapshotIdentifier", sourceDBSnapshotIdentifier())
.add("TargetDBSnapshotIdentifier", targetDBSnapshotIdentifier()).add("KmsKeyId", kmsKeyId()).add("Tags", tags())
.add("CopyTags", copyTags()).add("PreSignedUrl", preSignedUrl()).add("OptionGroupName", optionGroupName())
.add("SourceRegion", sourceRegion()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SourceDBSnapshotIdentifier":
return Optional.ofNullable(clazz.cast(sourceDBSnapshotIdentifier()));
case "TargetDBSnapshotIdentifier":
return Optional.ofNullable(clazz.cast(targetDBSnapshotIdentifier()));
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "CopyTags":
return Optional.ofNullable(clazz.cast(copyTags()));
case "PreSignedUrl":
return Optional.ofNullable(clazz.cast(preSignedUrl()));
case "OptionGroupName":
return Optional.ofNullable(clazz.cast(optionGroupName()));
case "SourceRegion":
return Optional.ofNullable(clazz.cast(sourceRegion()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CopyDbSnapshotRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier for the source DB snapshot.
*
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For
* example, you might specify
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of
* the shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region,
* and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*
*
* @param sourceDBSnapshotIdentifier
* The identifier for the source DB snapshot.
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
* For example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN.
* For example, you might specify
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name
* (ARN) of the shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS
* Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl
* parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier);
/**
*
* The identifier for the copy of the snapshot.
*
*
* Constraints:
*
*
* -
*
* Can't be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*
*
* @param targetDBSnapshotIdentifier
* The identifier for the copy of the snapshot.
*
* Constraints:
*
*
* -
*
* Can't be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetDBSnapshotIdentifier(String targetDBSnapshotIdentifier);
/**
*
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to
* encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the
* copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value
* for this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the
* destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you
* can't use encryption keys from one AWS Region in another AWS Region.
*
*
* @param kmsKeyId
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS
* key identifier, or the KMS key alias for the KMS encryption key.
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter
* to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter,
* then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a
* value for this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the
* destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in,
* and you can't use encryption keys from one AWS Region in another AWS Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
/**
* Sets the value of the Tags property for this object.
*
* @param tags
* The new value for the Tags property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
* Sets the value of the Tags property for this object.
*
* @param tags
* The new value for the Tags property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
* Sets the value of the Tags property for this object.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
/**
*
* A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By
* default, tags are not copied.
*
*
* @param copyTags
* A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot.
* By default, tags are not copied.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copyTags(Boolean copyTags);
/**
*
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in
* the source AWS Region that contains the source DB snapshot to copy.
*
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
* Amazon RDS API. You can specify the --source-region option instead of this parameter when you
* copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed
* in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
* contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region
* is the same one where the CopyDBSnapshot action is called that contains this presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region,
* then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL
* that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example,
* the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot
* in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action
* that is called in the destination AWS Region, and the action contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied.
* This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if
* you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests:
* Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*
* @param preSignedUrl
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API
* action in the source AWS Region that contains the source DB snapshot to copy.
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by
* using the Amazon RDS API. You can specify the --source-region option instead of this
* parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be
* executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned
* URL request must contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS
* Region is the same one where the CopyDBSnapshot action is called that contains this
* presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS
* Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a
* presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS
* Region. For this example, the DestinationRegion in the presigned URL must be set to the
* us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB
* snapshot in the destination AWS Region. This is the same identifier for both the
* CopyDBSnapshot action that is called in the destination AWS Region, and the action
* contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region.
* For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating
* Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4
* Signing Process.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder preSignedUrl(String preSignedUrl);
/**
*
* The name of an option group to associate with the copy of the snapshot.
*
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a
* nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft
* SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.
*
*
* @param optionGroupName
* The name of an option group to associate with the copy of the snapshot.
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance
* uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle
* or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more
* information, see Option Group Considerations in the Amazon RDS User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder optionGroupName(String optionGroupName);
/**
* The region where the source snapshot is located.
*
* @param sourceRegion
* The region where the source snapshot is located.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceRegion(String sourceRegion);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String sourceDBSnapshotIdentifier;
private String targetDBSnapshotIdentifier;
private String kmsKeyId;
private List tags = DefaultSdkAutoConstructList.getInstance();
private Boolean copyTags;
private String preSignedUrl;
private String optionGroupName;
private String sourceRegion;
private BuilderImpl() {
}
private BuilderImpl(CopyDbSnapshotRequest model) {
super(model);
sourceDBSnapshotIdentifier(model.sourceDBSnapshotIdentifier);
targetDBSnapshotIdentifier(model.targetDBSnapshotIdentifier);
kmsKeyId(model.kmsKeyId);
tags(model.tags);
copyTags(model.copyTags);
preSignedUrl(model.preSignedUrl);
optionGroupName(model.optionGroupName);
sourceRegion(model.sourceRegion);
}
public final String getSourceDBSnapshotIdentifier() {
return sourceDBSnapshotIdentifier;
}
@Override
public final Builder sourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier) {
this.sourceDBSnapshotIdentifier = sourceDBSnapshotIdentifier;
return this;
}
public final void setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier) {
this.sourceDBSnapshotIdentifier = sourceDBSnapshotIdentifier;
}
public final String getTargetDBSnapshotIdentifier() {
return targetDBSnapshotIdentifier;
}
@Override
public final Builder targetDBSnapshotIdentifier(String targetDBSnapshotIdentifier) {
this.targetDBSnapshotIdentifier = targetDBSnapshotIdentifier;
return this;
}
public final void setTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier) {
this.targetDBSnapshotIdentifier = targetDBSnapshotIdentifier;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
public final Collection getTags() {
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
public final Boolean getCopyTags() {
return copyTags;
}
@Override
public final Builder copyTags(Boolean copyTags) {
this.copyTags = copyTags;
return this;
}
public final void setCopyTags(Boolean copyTags) {
this.copyTags = copyTags;
}
public final String getPreSignedUrl() {
return preSignedUrl;
}
@Override
public final Builder preSignedUrl(String preSignedUrl) {
this.preSignedUrl = preSignedUrl;
return this;
}
public final void setPreSignedUrl(String preSignedUrl) {
this.preSignedUrl = preSignedUrl;
}
public final String getOptionGroupName() {
return optionGroupName;
}
@Override
public final Builder optionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
return this;
}
public final void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
public final String getSourceRegion() {
return sourceRegion;
}
@Override
public final Builder sourceRegion(String sourceRegion) {
this.sourceRegion = sourceRegion;
return this;
}
public final void setSourceRegion(String sourceRegion) {
this.sourceRegion = sourceRegion;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CopyDbSnapshotRequest build() {
return new CopyDbSnapshotRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}