com.amazonaws.services.rds.model.RestoreDBClusterFromS3Request Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2016-2021 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 com.amazonaws.services.rds.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RestoreDBClusterFromS3Request extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*
*/
private com.amazonaws.internal.SdkInternalList availabilityZones;
/**
*
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a
* minimum value of 1.
*
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
*
*/
private Integer backupRetentionPeriod;
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*
*/
private String characterSetName;
/**
*
* The database name for the restored DB cluster.
*
*/
private String databaseName;
/**
*
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
*
*/
private String dBClusterIdentifier;
/**
*
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
*
*/
private String dBClusterParameterGroupName;
/**
*
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*
*/
private com.amazonaws.internal.SdkInternalList vpcSecurityGroupIds;
/**
*
* A DB subnet group to associate with the restored DB cluster.
*
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*/
private String dBSubnetGroupName;
/**
*
* The name of the database engine to be used for this DB cluster.
*
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
*
*/
private String engine;
/**
*
* The version number of the database engine to use.
*
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the
* following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use
* the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
*
*/
private String engineVersion;
/**
*
* The port number on which the instances in the restored DB cluster accept connections.
*
*
* Default: 3306
*
*/
private Integer port;
/**
*
* The name of the master user for the restored DB cluster.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
*
*/
private String masterUsername;
/**
*
* The password for the master database user. This password can contain any printable ASCII character except "/",
* """, or "@".
*
*
* Constraints: Must contain from 8 to 41 characters.
*
*/
private String masterUserPassword;
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified option group.
*
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once
* it is associated with a DB cluster.
*
*/
private String optionGroupName;
/**
*
* The daily time range during which automated backups are created if automated backups are enabled using the
* BackupRetentionPeriod parameter.
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*/
private String preferredBackupWindow;
/**
*
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
*
*/
private String preferredMaintenanceWindow;
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* A value that indicates whether the restored DB cluster is encrypted.
*
*/
private Boolean storageEncrypted;
/**
*
* The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To
* use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
* parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
*
*/
private String kmsKeyId;
/**
*
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
* accounts to database accounts. By default, mapping is disabled.
*
*
* For more information, see IAM Database
* Authentication in the Amazon Aurora User Guide.
*
*/
private Boolean enableIAMDatabaseAuthentication;
/**
*
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
*
*
* Valid values: mysql
*
*/
private String sourceEngine;
/**
*
* The version of the database that the backup files were created from.
*
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
*
*/
private String sourceEngineVersion;
/**
*
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*
*/
private String s3BucketName;
/**
*
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do
* not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files
* in the Amazon S3 bucket.
*
*/
private String s3Prefix;
/**
*
* The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*
*/
private String s3IngestionRoleArn;
/**
*
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
*
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
*
*/
private Long backtrackWindow;
/**
*
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on
* the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*
*/
private com.amazonaws.internal.SdkInternalList enableCloudwatchLogsExports;
/**
*
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection is disabled.
*
*/
private Boolean deletionProtection;
/**
*
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
* cluster. The default is not to copy them.
*
*/
private Boolean copyTagsToSnapshot;
/**
*
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
* operation.
*
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to
* the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
*
*/
private String domain;
/**
*
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*
*/
private String domainIAMRoleName;
/**
*
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*
*
* @return A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*/
public java.util.List getAvailabilityZones() {
if (availabilityZones == null) {
availabilityZones = new com.amazonaws.internal.SdkInternalList();
}
return availabilityZones;
}
/**
*
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*
*
* @param availabilityZones
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*/
public void setAvailabilityZones(java.util.Collection availabilityZones) {
if (availabilityZones == null) {
this.availabilityZones = null;
return;
}
this.availabilityZones = new com.amazonaws.internal.SdkInternalList(availabilityZones);
}
/**
*
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAvailabilityZones(java.util.Collection)} or {@link #withAvailabilityZones(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param availabilityZones
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withAvailabilityZones(String... availabilityZones) {
if (this.availabilityZones == null) {
setAvailabilityZones(new com.amazonaws.internal.SdkInternalList(availabilityZones.length));
}
for (String ele : availabilityZones) {
this.availabilityZones.add(ele);
}
return this;
}
/**
*
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*
*
* @param availabilityZones
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withAvailabilityZones(java.util.Collection availabilityZones) {
setAvailabilityZones(availabilityZones);
return this;
}
/**
*
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a
* minimum value of 1.
*
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
*
*
* @param backupRetentionPeriod
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a
* minimum value of 1.
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
*/
public void setBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
}
/**
*
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a
* minimum value of 1.
*
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
*
*
* @return The number of days for which automated backups of the restored DB cluster are retained. You must specify
* a minimum value of 1.
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
*/
public Integer getBackupRetentionPeriod() {
return this.backupRetentionPeriod;
}
/**
*
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a
* minimum value of 1.
*
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
*
*
* @param backupRetentionPeriod
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a
* minimum value of 1.
*
* Default: 1
*
*
* Constraints:
*
*
* -
*
* Must be a value from 1 to 35
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withBackupRetentionPeriod(Integer backupRetentionPeriod) {
setBackupRetentionPeriod(backupRetentionPeriod);
return this;
}
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*
*
* @param characterSetName
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*/
public void setCharacterSetName(String characterSetName) {
this.characterSetName = characterSetName;
}
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*
*
* @return A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*/
public String getCharacterSetName() {
return this.characterSetName;
}
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*
*
* @param characterSetName
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withCharacterSetName(String characterSetName) {
setCharacterSetName(characterSetName);
return this;
}
/**
*
* The database name for the restored DB cluster.
*
*
* @param databaseName
* The database name for the restored DB cluster.
*/
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
/**
*
* The database name for the restored DB cluster.
*
*
* @return The database name for the restored DB cluster.
*/
public String getDatabaseName() {
return this.databaseName;
}
/**
*
* The database name for the restored DB cluster.
*
*
* @param databaseName
* The database name for the restored DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDatabaseName(String databaseName) {
setDatabaseName(databaseName);
return this;
}
/**
*
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
*
*
* @param dBClusterIdentifier
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
*/
public void setDBClusterIdentifier(String dBClusterIdentifier) {
this.dBClusterIdentifier = dBClusterIdentifier;
}
/**
*
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
*
*
* @return The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
*/
public String getDBClusterIdentifier() {
return this.dBClusterIdentifier;
}
/**
*
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
*
*
* @param dBClusterIdentifier
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't
* case-sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster1
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDBClusterIdentifier(String dBClusterIdentifier) {
setDBClusterIdentifier(dBClusterIdentifier);
return this;
}
/**
*
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
*
*
* @param dBClusterParameterGroupName
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
*/
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName) {
this.dBClusterParameterGroupName = dBClusterParameterGroupName;
}
/**
*
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
*
*
* @return The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
*/
public String getDBClusterParameterGroupName() {
return this.dBClusterParameterGroupName;
}
/**
*
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
*
*
* @param dBClusterParameterGroupName
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
* omitted, default.aurora5.6 is used.
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBClusterParameterGroup.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDBClusterParameterGroupName(String dBClusterParameterGroupName) {
setDBClusterParameterGroupName(dBClusterParameterGroupName);
return this;
}
/**
*
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*
*
* @return A list of EC2 VPC security groups to associate with the restored DB cluster.
*/
public java.util.List getVpcSecurityGroupIds() {
if (vpcSecurityGroupIds == null) {
vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList();
}
return vpcSecurityGroupIds;
}
/**
*
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*
*
* @param vpcSecurityGroupIds
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*/
public void setVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
if (vpcSecurityGroupIds == null) {
this.vpcSecurityGroupIds = null;
return;
}
this.vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds);
}
/**
*
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVpcSecurityGroupIds(java.util.Collection)} or {@link #withVpcSecurityGroupIds(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param vpcSecurityGroupIds
* A list of EC2 VPC security groups to associate with the restored DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withVpcSecurityGroupIds(String... vpcSecurityGroupIds) {
if (this.vpcSecurityGroupIds == null) {
setVpcSecurityGroupIds(new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds.length));
}
for (String ele : vpcSecurityGroupIds) {
this.vpcSecurityGroupIds.add(ele);
}
return this;
}
/**
*
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*
*
* @param vpcSecurityGroupIds
* A list of EC2 VPC security groups to associate with the restored DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
setVpcSecurityGroupIds(vpcSecurityGroupIds);
return this;
}
/**
*
* A DB subnet group to associate with the restored DB cluster.
*
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*
* @param dBSubnetGroupName
* A DB subnet group to associate with the restored DB cluster.
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*/
public void setDBSubnetGroupName(String dBSubnetGroupName) {
this.dBSubnetGroupName = dBSubnetGroupName;
}
/**
*
* A DB subnet group to associate with the restored DB cluster.
*
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*
* @return A DB subnet group to associate with the restored DB cluster.
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*/
public String getDBSubnetGroupName() {
return this.dBSubnetGroupName;
}
/**
*
* A DB subnet group to associate with the restored DB cluster.
*
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
*
*
* @param dBSubnetGroupName
* A DB subnet group to associate with the restored DB cluster.
*
* Constraints: If supplied, must match the name of an existing DBSubnetGroup.
*
*
* Example: mySubnetgroup
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDBSubnetGroupName(String dBSubnetGroupName) {
setDBSubnetGroupName(dBSubnetGroupName);
return this;
}
/**
*
* The name of the database engine to be used for this DB cluster.
*
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
*
*
* @param engine
* The name of the database engine to be used for this DB cluster.
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
*/
public void setEngine(String engine) {
this.engine = engine;
}
/**
*
* The name of the database engine to be used for this DB cluster.
*
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
*
*
* @return The name of the database engine to be used for this DB cluster.
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
*/
public String getEngine() {
return this.engine;
}
/**
*
* The name of the database engine to be used for this DB cluster.
*
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
*
*
* @param engine
* The name of the database engine to be used for this DB cluster.
*
* Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
* 5.7-compatible Aurora), and aurora-postgresql
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withEngine(String engine) {
setEngine(engine);
return this;
}
/**
*
* The version number of the database engine to use.
*
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the
* following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use
* the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
*
*
* @param engineVersion
* The version number of the database engine to use.
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora),
* use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible
* Aurora), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following
* command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
*/
public void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
/**
*
* The version number of the database engine to use.
*
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the
* following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use
* the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
*
*
* @return The version number of the database engine to use.
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora),
* use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible
* Aurora), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following
* command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
*/
public String getEngineVersion() {
return this.engineVersion;
}
/**
*
* The version number of the database engine to use.
*
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the
* following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use
* the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
*
*
* @param engineVersion
* The version number of the database engine to use.
*
* To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora),
* use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible
* Aurora), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
*
*
* To list all of the available engine versions for aurora-postgresql, use the following
* command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*
*
* Aurora MySQL
*
*
* Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
* 5.7.mysql_aurora.2.04.5
*
*
* Aurora PostgreSQL
*
*
* Example: 9.6.3, 10.7
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withEngineVersion(String engineVersion) {
setEngineVersion(engineVersion);
return this;
}
/**
*
* The port number on which the instances in the restored DB cluster accept connections.
*
*
* Default: 3306
*
*
* @param port
* The port number on which the instances in the restored DB cluster accept connections.
*
* Default: 3306
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port number on which the instances in the restored DB cluster accept connections.
*
*
* Default: 3306
*
*
* @return The port number on which the instances in the restored DB cluster accept connections.
*
* Default: 3306
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port number on which the instances in the restored DB cluster accept connections.
*
*
* Default: 3306
*
*
* @param port
* The port number on which the instances in the restored DB cluster accept connections.
*
* Default: 3306
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* The name of the master user for the restored DB cluster.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
*
*
* @param masterUsername
* The name of the master user for the restored DB cluster.
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
*/
public void setMasterUsername(String masterUsername) {
this.masterUsername = masterUsername;
}
/**
*
* The name of the master user for the restored DB cluster.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
*
*
* @return The name of the master user for the restored DB cluster.
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
*/
public String getMasterUsername() {
return this.masterUsername;
}
/**
*
* The name of the master user for the restored DB cluster.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
*
*
* @param masterUsername
* The name of the master user for the restored DB cluster.
*
* Constraints:
*
*
* -
*
* Must be 1 to 16 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't be a reserved word for the chosen database engine.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withMasterUsername(String masterUsername) {
setMasterUsername(masterUsername);
return this;
}
/**
*
* The password for the master database user. This password can contain any printable ASCII character except "/",
* """, or "@".
*
*
* Constraints: Must contain from 8 to 41 characters.
*
*
* @param masterUserPassword
* The password for the master database user. This password can contain any printable ASCII character except
* "/", """, or "@".
*
* Constraints: Must contain from 8 to 41 characters.
*/
public void setMasterUserPassword(String masterUserPassword) {
this.masterUserPassword = masterUserPassword;
}
/**
*
* The password for the master database user. This password can contain any printable ASCII character except "/",
* """, or "@".
*
*
* Constraints: Must contain from 8 to 41 characters.
*
*
* @return The password for the master database user. This password can contain any printable ASCII character except
* "/", """, or "@".
*
* Constraints: Must contain from 8 to 41 characters.
*/
public String getMasterUserPassword() {
return this.masterUserPassword;
}
/**
*
* The password for the master database user. This password can contain any printable ASCII character except "/",
* """, or "@".
*
*
* Constraints: Must contain from 8 to 41 characters.
*
*
* @param masterUserPassword
* The password for the master database user. This password can contain any printable ASCII character except
* "/", """, or "@".
*
* Constraints: Must contain from 8 to 41 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withMasterUserPassword(String masterUserPassword) {
setMasterUserPassword(masterUserPassword);
return this;
}
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified option group.
*
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once
* it is associated with a DB cluster.
*
*
* @param optionGroupName
* A value that indicates that the restored DB cluster should be associated with the specified option
* group.
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB
* cluster once it is associated with a DB cluster.
*/
public void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified option group.
*
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once
* it is associated with a DB cluster.
*
*
* @return A value that indicates that the restored DB cluster should be associated with the specified option
* group.
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB
* cluster once it is associated with a DB cluster.
*/
public String getOptionGroupName() {
return this.optionGroupName;
}
/**
*
* A value that indicates that the restored DB cluster should be associated with the specified option group.
*
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once
* it is associated with a DB cluster.
*
*
* @param optionGroupName
* A value that indicates that the restored DB cluster should be associated with the specified option
* group.
*
* Permanent options can't be removed from an option group. An option group can't be removed from a DB
* cluster once it is associated with a DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withOptionGroupName(String optionGroupName) {
setOptionGroupName(optionGroupName);
return this;
}
/**
*
* The daily time range during which automated backups are created if automated backups are enabled using the
* BackupRetentionPeriod parameter.
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @param preferredBackupWindow
* The daily time range during which automated backups are created if automated backups are enabled using the
* BackupRetentionPeriod parameter.
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*/
public void setPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
}
/**
*
* The daily time range during which automated backups are created if automated backups are enabled using the
* BackupRetentionPeriod parameter.
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @return The daily time range during which automated backups are created if automated backups are enabled using
* the BackupRetentionPeriod parameter.
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*/
public String getPreferredBackupWindow() {
return this.preferredBackupWindow;
}
/**
*
* The daily time range during which automated backups are created if automated backups are enabled using the
* BackupRetentionPeriod parameter.
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @param preferredBackupWindow
* The daily time range during which automated backups are created if automated backups are enabled using the
* BackupRetentionPeriod parameter.
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
*
*
* Constraints:
*
*
* -
*
* Must be in the format hh24:mi-hh24:mi.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withPreferredBackupWindow(String preferredBackupWindow) {
setPreferredBackupWindow(preferredBackupWindow);
return this;
}
/**
*
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
*
*
* @param preferredMaintenanceWindow
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
*/
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = preferredMaintenanceWindow;
}
/**
*
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
*
*
* @return The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
*/
public String getPreferredMaintenanceWindow() {
return this.preferredMaintenanceWindow;
}
/**
*
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services
* Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
*
*
* @param preferredMaintenanceWindow
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
*
* The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
* Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
*
*
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
*
*
* Constraints: Minimum 30-minute window.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
setPreferredMaintenanceWindow(preferredMaintenanceWindow);
return this;
}
/**
* @return
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
* @param tags
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* A value that indicates whether the restored DB cluster is encrypted.
*
*
* @param storageEncrypted
* A value that indicates whether the restored DB cluster is encrypted.
*/
public void setStorageEncrypted(Boolean storageEncrypted) {
this.storageEncrypted = storageEncrypted;
}
/**
*
* A value that indicates whether the restored DB cluster is encrypted.
*
*
* @return A value that indicates whether the restored DB cluster is encrypted.
*/
public Boolean getStorageEncrypted() {
return this.storageEncrypted;
}
/**
*
* A value that indicates whether the restored DB cluster is encrypted.
*
*
* @param storageEncrypted
* A value that indicates whether the restored DB cluster is encrypted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withStorageEncrypted(Boolean storageEncrypted) {
setStorageEncrypted(storageEncrypted);
return this;
}
/**
*
* A value that indicates whether the restored DB cluster is encrypted.
*
*
* @return A value that indicates whether the restored DB cluster is encrypted.
*/
public Boolean isStorageEncrypted() {
return this.storageEncrypted;
}
/**
*
* The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To
* use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
* parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
*
*
* @param kmsKeyId
* The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS
* key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
* parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web
* Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web
* Services Region.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To
* use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
* parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
*
*
* @return The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS
* key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the
* KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS
* key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS
* key for each Amazon Web Services Region.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To
* use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
* parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
*
*
* @param kmsKeyId
* The Amazon Web Services KMS key identifier for an encrypted DB cluster.
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS
* key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
* parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web
* Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web
* Services Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
* accounts to database accounts. By default, mapping is disabled.
*
*
* For more information, see IAM Database
* Authentication in the Amazon Aurora User Guide.
*
*
* @param enableIAMDatabaseAuthentication
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
* (IAM) accounts to database accounts. By default, mapping is disabled.
*
* For more information, see IAM
* Database Authentication in the Amazon Aurora User Guide.
*/
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) {
this.enableIAMDatabaseAuthentication = enableIAMDatabaseAuthentication;
}
/**
*
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
* accounts to database accounts. By default, mapping is disabled.
*
*
* For more information, see IAM Database
* Authentication in the Amazon Aurora User Guide.
*
*
* @return A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
* (IAM) accounts to database accounts. By default, mapping is disabled.
*
* For more information, see IAM
* Database Authentication in the Amazon Aurora User Guide.
*/
public Boolean getEnableIAMDatabaseAuthentication() {
return this.enableIAMDatabaseAuthentication;
}
/**
*
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
* accounts to database accounts. By default, mapping is disabled.
*
*
* For more information, see IAM Database
* Authentication in the Amazon Aurora User Guide.
*
*
* @param enableIAMDatabaseAuthentication
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
* (IAM) accounts to database accounts. By default, mapping is disabled.
*
* For more information, see IAM
* Database Authentication in the Amazon Aurora User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) {
setEnableIAMDatabaseAuthentication(enableIAMDatabaseAuthentication);
return this;
}
/**
*
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
* accounts to database accounts. By default, mapping is disabled.
*
*
* For more information, see IAM Database
* Authentication in the Amazon Aurora User Guide.
*
*
* @return A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
* (IAM) accounts to database accounts. By default, mapping is disabled.
*
* For more information, see IAM
* Database Authentication in the Amazon Aurora User Guide.
*/
public Boolean isEnableIAMDatabaseAuthentication() {
return this.enableIAMDatabaseAuthentication;
}
/**
*
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
*
*
* Valid values: mysql
*
*
* @param sourceEngine
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3
* bucket.
*
* Valid values: mysql
*/
public void setSourceEngine(String sourceEngine) {
this.sourceEngine = sourceEngine;
}
/**
*
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
*
*
* Valid values: mysql
*
*
* @return The identifier for the database engine that was backed up to create the files stored in the Amazon S3
* bucket.
*
* Valid values: mysql
*/
public String getSourceEngine() {
return this.sourceEngine;
}
/**
*
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
*
*
* Valid values: mysql
*
*
* @param sourceEngine
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3
* bucket.
*
* Valid values: mysql
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withSourceEngine(String sourceEngine) {
setSourceEngine(sourceEngine);
return this;
}
/**
*
* The version of the database that the backup files were created from.
*
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
*
*
* @param sourceEngineVersion
* The version of the database that the backup files were created from.
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
*/
public void setSourceEngineVersion(String sourceEngineVersion) {
this.sourceEngineVersion = sourceEngineVersion;
}
/**
*
* The version of the database that the backup files were created from.
*
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
*
*
* @return The version of the database that the backup files were created from.
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
*/
public String getSourceEngineVersion() {
return this.sourceEngineVersion;
}
/**
*
* The version of the database that the backup files were created from.
*
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
*
*
* @param sourceEngineVersion
* The version of the database that the backup files were created from.
*
* MySQL versions 5.5, 5.6, and 5.7 are supported.
*
*
* Example: 5.6.40, 5.7.28
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withSourceEngineVersion(String sourceEngineVersion) {
setSourceEngineVersion(sourceEngineVersion);
return this;
}
/**
*
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*
*
* @param s3BucketName
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*/
public void setS3BucketName(String s3BucketName) {
this.s3BucketName = s3BucketName;
}
/**
*
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*
*
* @return The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*/
public String getS3BucketName() {
return this.s3BucketName;
}
/**
*
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*
*
* @param s3BucketName
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withS3BucketName(String s3BucketName) {
setS3BucketName(s3BucketName);
return this;
}
/**
*
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do
* not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files
* in the Amazon S3 bucket.
*
*
* @param s3Prefix
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If
* you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using
* all of the files in the Amazon S3 bucket.
*/
public void setS3Prefix(String s3Prefix) {
this.s3Prefix = s3Prefix;
}
/**
*
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do
* not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files
* in the Amazon S3 bucket.
*
*
* @return The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
* If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by
* using all of the files in the Amazon S3 bucket.
*/
public String getS3Prefix() {
return this.s3Prefix;
}
/**
*
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do
* not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files
* in the Amazon S3 bucket.
*
*
* @param s3Prefix
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If
* you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using
* all of the files in the Amazon S3 bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withS3Prefix(String s3Prefix) {
setS3Prefix(s3Prefix);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*
*
* @param s3IngestionRoleArn
* The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*/
public void setS3IngestionRoleArn(String s3IngestionRoleArn) {
this.s3IngestionRoleArn = s3IngestionRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*/
public String getS3IngestionRoleArn() {
return this.s3IngestionRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*
*
* @param s3IngestionRoleArn
* The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that
* authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withS3IngestionRoleArn(String s3IngestionRoleArn) {
setS3IngestionRoleArn(s3IngestionRoleArn);
return this;
}
/**
*
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
*
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
*
*
* @param backtrackWindow
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
*/
public void setBacktrackWindow(Long backtrackWindow) {
this.backtrackWindow = backtrackWindow;
}
/**
*
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
*
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
*
*
* @return The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
*/
public Long getBacktrackWindow() {
return this.backtrackWindow;
}
/**
*
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
*
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
*
*
* @param backtrackWindow
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
*
* Currently, Backtrack is only supported for Aurora MySQL DB clusters.
*
*
*
* Default: 0
*
*
* Constraints:
*
*
* -
*
* If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withBacktrackWindow(Long backtrackWindow) {
setBacktrackWindow(backtrackWindow);
return this;
}
/**
*
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on
* the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*
*
* @return The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
* depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*/
public java.util.List getEnableCloudwatchLogsExports() {
if (enableCloudwatchLogsExports == null) {
enableCloudwatchLogsExports = new com.amazonaws.internal.SdkInternalList();
}
return enableCloudwatchLogsExports;
}
/**
*
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on
* the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*
*
* @param enableCloudwatchLogsExports
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
* depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*/
public void setEnableCloudwatchLogsExports(java.util.Collection enableCloudwatchLogsExports) {
if (enableCloudwatchLogsExports == null) {
this.enableCloudwatchLogsExports = null;
return;
}
this.enableCloudwatchLogsExports = new com.amazonaws.internal.SdkInternalList(enableCloudwatchLogsExports);
}
/**
*
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on
* the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setEnableCloudwatchLogsExports(java.util.Collection)} or
* {@link #withEnableCloudwatchLogsExports(java.util.Collection)} if you want to override the existing values.
*
*
* @param enableCloudwatchLogsExports
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
* depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports) {
if (this.enableCloudwatchLogsExports == null) {
setEnableCloudwatchLogsExports(new com.amazonaws.internal.SdkInternalList(enableCloudwatchLogsExports.length));
}
for (String ele : enableCloudwatchLogsExports) {
this.enableCloudwatchLogsExports.add(ele);
}
return this;
}
/**
*
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on
* the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*
*
* @param enableCloudwatchLogsExports
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
* depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withEnableCloudwatchLogsExports(java.util.Collection enableCloudwatchLogsExports) {
setEnableCloudwatchLogsExports(enableCloudwatchLogsExports);
return this;
}
/**
*
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection is disabled.
*
*
* @param deletionProtection
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
* deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
public void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
}
/**
*
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection is disabled.
*
*
* @return A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
* deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
public Boolean getDeletionProtection() {
return this.deletionProtection;
}
/**
*
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection is disabled.
*
*
* @param deletionProtection
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
* deleted when deletion protection is enabled. By default, deletion protection is disabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDeletionProtection(Boolean deletionProtection) {
setDeletionProtection(deletionProtection);
return this;
}
/**
*
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection is disabled.
*
*
* @return A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
* deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
public Boolean isDeletionProtection() {
return this.deletionProtection;
}
/**
*
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
* cluster. The default is not to copy them.
*
*
* @param copyTagsToSnapshot
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
* DB cluster. The default is not to copy them.
*/
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot) {
this.copyTagsToSnapshot = copyTagsToSnapshot;
}
/**
*
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
* cluster. The default is not to copy them.
*
*
* @return A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
* DB cluster. The default is not to copy them.
*/
public Boolean getCopyTagsToSnapshot() {
return this.copyTagsToSnapshot;
}
/**
*
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
* cluster. The default is not to copy them.
*
*
* @param copyTagsToSnapshot
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
* DB cluster. The default is not to copy them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withCopyTagsToSnapshot(Boolean copyTagsToSnapshot) {
setCopyTagsToSnapshot(copyTagsToSnapshot);
return this;
}
/**
*
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
* cluster. The default is not to copy them.
*
*
* @return A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
* DB cluster. The default is not to copy them.
*/
public Boolean isCopyTagsToSnapshot() {
return this.copyTagsToSnapshot;
}
/**
*
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
* operation.
*
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to
* the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
*
*
* @param domain
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior
* to this operation.
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that
* connect to the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
* operation.
*
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to
* the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
*
*
* @return Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior
* to this operation.
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that
* connect to the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
*/
public String getDomain() {
return this.domain;
}
/**
*
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
* operation.
*
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to
* the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
*
*
* @param domain
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior
* to this operation.
*
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that
* connect to the DB cluster. For more information, see Kerberos
* Authentication in the Amazon Aurora User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*
*
* @param domainIAMRoleName
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
public void setDomainIAMRoleName(String domainIAMRoleName) {
this.domainIAMRoleName = domainIAMRoleName;
}
/**
*
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*
*
* @return Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
public String getDomainIAMRoleName() {
return this.domainIAMRoleName;
}
/**
*
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*
*
* @param domainIAMRoleName
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreDBClusterFromS3Request withDomainIAMRoleName(String domainIAMRoleName) {
setDomainIAMRoleName(domainIAMRoleName);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAvailabilityZones() != null)
sb.append("AvailabilityZones: ").append(getAvailabilityZones()).append(",");
if (getBackupRetentionPeriod() != null)
sb.append("BackupRetentionPeriod: ").append(getBackupRetentionPeriod()).append(",");
if (getCharacterSetName() != null)
sb.append("CharacterSetName: ").append(getCharacterSetName()).append(",");
if (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).append(",");
if (getDBClusterIdentifier() != null)
sb.append("DBClusterIdentifier: ").append(getDBClusterIdentifier()).append(",");
if (getDBClusterParameterGroupName() != null)
sb.append("DBClusterParameterGroupName: ").append(getDBClusterParameterGroupName()).append(",");
if (getVpcSecurityGroupIds() != null)
sb.append("VpcSecurityGroupIds: ").append(getVpcSecurityGroupIds()).append(",");
if (getDBSubnetGroupName() != null)
sb.append("DBSubnetGroupName: ").append(getDBSubnetGroupName()).append(",");
if (getEngine() != null)
sb.append("Engine: ").append(getEngine()).append(",");
if (getEngineVersion() != null)
sb.append("EngineVersion: ").append(getEngineVersion()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getMasterUsername() != null)
sb.append("MasterUsername: ").append(getMasterUsername()).append(",");
if (getMasterUserPassword() != null)
sb.append("MasterUserPassword: ").append(getMasterUserPassword()).append(",");
if (getOptionGroupName() != null)
sb.append("OptionGroupName: ").append(getOptionGroupName()).append(",");
if (getPreferredBackupWindow() != null)
sb.append("PreferredBackupWindow: ").append(getPreferredBackupWindow()).append(",");
if (getPreferredMaintenanceWindow() != null)
sb.append("PreferredMaintenanceWindow: ").append(getPreferredMaintenanceWindow()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getStorageEncrypted() != null)
sb.append("StorageEncrypted: ").append(getStorageEncrypted()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getEnableIAMDatabaseAuthentication() != null)
sb.append("EnableIAMDatabaseAuthentication: ").append(getEnableIAMDatabaseAuthentication()).append(",");
if (getSourceEngine() != null)
sb.append("SourceEngine: ").append(getSourceEngine()).append(",");
if (getSourceEngineVersion() != null)
sb.append("SourceEngineVersion: ").append(getSourceEngineVersion()).append(",");
if (getS3BucketName() != null)
sb.append("S3BucketName: ").append(getS3BucketName()).append(",");
if (getS3Prefix() != null)
sb.append("S3Prefix: ").append(getS3Prefix()).append(",");
if (getS3IngestionRoleArn() != null)
sb.append("S3IngestionRoleArn: ").append(getS3IngestionRoleArn()).append(",");
if (getBacktrackWindow() != null)
sb.append("BacktrackWindow: ").append(getBacktrackWindow()).append(",");
if (getEnableCloudwatchLogsExports() != null)
sb.append("EnableCloudwatchLogsExports: ").append(getEnableCloudwatchLogsExports()).append(",");
if (getDeletionProtection() != null)
sb.append("DeletionProtection: ").append(getDeletionProtection()).append(",");
if (getCopyTagsToSnapshot() != null)
sb.append("CopyTagsToSnapshot: ").append(getCopyTagsToSnapshot()).append(",");
if (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getDomainIAMRoleName() != null)
sb.append("DomainIAMRoleName: ").append(getDomainIAMRoleName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RestoreDBClusterFromS3Request == false)
return false;
RestoreDBClusterFromS3Request other = (RestoreDBClusterFromS3Request) obj;
if (other.getAvailabilityZones() == null ^ this.getAvailabilityZones() == null)
return false;
if (other.getAvailabilityZones() != null && other.getAvailabilityZones().equals(this.getAvailabilityZones()) == false)
return false;
if (other.getBackupRetentionPeriod() == null ^ this.getBackupRetentionPeriod() == null)
return false;
if (other.getBackupRetentionPeriod() != null && other.getBackupRetentionPeriod().equals(this.getBackupRetentionPeriod()) == false)
return false;
if (other.getCharacterSetName() == null ^ this.getCharacterSetName() == null)
return false;
if (other.getCharacterSetName() != null && other.getCharacterSetName().equals(this.getCharacterSetName()) == false)
return false;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == false)
return false;
if (other.getDBClusterIdentifier() == null ^ this.getDBClusterIdentifier() == null)
return false;
if (other.getDBClusterIdentifier() != null && other.getDBClusterIdentifier().equals(this.getDBClusterIdentifier()) == false)
return false;
if (other.getDBClusterParameterGroupName() == null ^ this.getDBClusterParameterGroupName() == null)
return false;
if (other.getDBClusterParameterGroupName() != null && other.getDBClusterParameterGroupName().equals(this.getDBClusterParameterGroupName()) == false)
return false;
if (other.getVpcSecurityGroupIds() == null ^ this.getVpcSecurityGroupIds() == null)
return false;
if (other.getVpcSecurityGroupIds() != null && other.getVpcSecurityGroupIds().equals(this.getVpcSecurityGroupIds()) == false)
return false;
if (other.getDBSubnetGroupName() == null ^ this.getDBSubnetGroupName() == null)
return false;
if (other.getDBSubnetGroupName() != null && other.getDBSubnetGroupName().equals(this.getDBSubnetGroupName()) == false)
return false;
if (other.getEngine() == null ^ this.getEngine() == null)
return false;
if (other.getEngine() != null && other.getEngine().equals(this.getEngine()) == false)
return false;
if (other.getEngineVersion() == null ^ this.getEngineVersion() == null)
return false;
if (other.getEngineVersion() != null && other.getEngineVersion().equals(this.getEngineVersion()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getMasterUsername() == null ^ this.getMasterUsername() == null)
return false;
if (other.getMasterUsername() != null && other.getMasterUsername().equals(this.getMasterUsername()) == false)
return false;
if (other.getMasterUserPassword() == null ^ this.getMasterUserPassword() == null)
return false;
if (other.getMasterUserPassword() != null && other.getMasterUserPassword().equals(this.getMasterUserPassword()) == false)
return false;
if (other.getOptionGroupName() == null ^ this.getOptionGroupName() == null)
return false;
if (other.getOptionGroupName() != null && other.getOptionGroupName().equals(this.getOptionGroupName()) == false)
return false;
if (other.getPreferredBackupWindow() == null ^ this.getPreferredBackupWindow() == null)
return false;
if (other.getPreferredBackupWindow() != null && other.getPreferredBackupWindow().equals(this.getPreferredBackupWindow()) == false)
return false;
if (other.getPreferredMaintenanceWindow() == null ^ this.getPreferredMaintenanceWindow() == null)
return false;
if (other.getPreferredMaintenanceWindow() != null && other.getPreferredMaintenanceWindow().equals(this.getPreferredMaintenanceWindow()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getStorageEncrypted() == null ^ this.getStorageEncrypted() == null)
return false;
if (other.getStorageEncrypted() != null && other.getStorageEncrypted().equals(this.getStorageEncrypted()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getEnableIAMDatabaseAuthentication() == null ^ this.getEnableIAMDatabaseAuthentication() == null)
return false;
if (other.getEnableIAMDatabaseAuthentication() != null
&& other.getEnableIAMDatabaseAuthentication().equals(this.getEnableIAMDatabaseAuthentication()) == false)
return false;
if (other.getSourceEngine() == null ^ this.getSourceEngine() == null)
return false;
if (other.getSourceEngine() != null && other.getSourceEngine().equals(this.getSourceEngine()) == false)
return false;
if (other.getSourceEngineVersion() == null ^ this.getSourceEngineVersion() == null)
return false;
if (other.getSourceEngineVersion() != null && other.getSourceEngineVersion().equals(this.getSourceEngineVersion()) == false)
return false;
if (other.getS3BucketName() == null ^ this.getS3BucketName() == null)
return false;
if (other.getS3BucketName() != null && other.getS3BucketName().equals(this.getS3BucketName()) == false)
return false;
if (other.getS3Prefix() == null ^ this.getS3Prefix() == null)
return false;
if (other.getS3Prefix() != null && other.getS3Prefix().equals(this.getS3Prefix()) == false)
return false;
if (other.getS3IngestionRoleArn() == null ^ this.getS3IngestionRoleArn() == null)
return false;
if (other.getS3IngestionRoleArn() != null && other.getS3IngestionRoleArn().equals(this.getS3IngestionRoleArn()) == false)
return false;
if (other.getBacktrackWindow() == null ^ this.getBacktrackWindow() == null)
return false;
if (other.getBacktrackWindow() != null && other.getBacktrackWindow().equals(this.getBacktrackWindow()) == false)
return false;
if (other.getEnableCloudwatchLogsExports() == null ^ this.getEnableCloudwatchLogsExports() == null)
return false;
if (other.getEnableCloudwatchLogsExports() != null && other.getEnableCloudwatchLogsExports().equals(this.getEnableCloudwatchLogsExports()) == false)
return false;
if (other.getDeletionProtection() == null ^ this.getDeletionProtection() == null)
return false;
if (other.getDeletionProtection() != null && other.getDeletionProtection().equals(this.getDeletionProtection()) == false)
return false;
if (other.getCopyTagsToSnapshot() == null ^ this.getCopyTagsToSnapshot() == null)
return false;
if (other.getCopyTagsToSnapshot() != null && other.getCopyTagsToSnapshot().equals(this.getCopyTagsToSnapshot()) == false)
return false;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getDomainIAMRoleName() == null ^ this.getDomainIAMRoleName() == null)
return false;
if (other.getDomainIAMRoleName() != null && other.getDomainIAMRoleName().equals(this.getDomainIAMRoleName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAvailabilityZones() == null) ? 0 : getAvailabilityZones().hashCode());
hashCode = prime * hashCode + ((getBackupRetentionPeriod() == null) ? 0 : getBackupRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getCharacterSetName() == null) ? 0 : getCharacterSetName().hashCode());
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().hashCode());
hashCode = prime * hashCode + ((getDBClusterIdentifier() == null) ? 0 : getDBClusterIdentifier().hashCode());
hashCode = prime * hashCode + ((getDBClusterParameterGroupName() == null) ? 0 : getDBClusterParameterGroupName().hashCode());
hashCode = prime * hashCode + ((getVpcSecurityGroupIds() == null) ? 0 : getVpcSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getDBSubnetGroupName() == null) ? 0 : getDBSubnetGroupName().hashCode());
hashCode = prime * hashCode + ((getEngine() == null) ? 0 : getEngine().hashCode());
hashCode = prime * hashCode + ((getEngineVersion() == null) ? 0 : getEngineVersion().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getMasterUsername() == null) ? 0 : getMasterUsername().hashCode());
hashCode = prime * hashCode + ((getMasterUserPassword() == null) ? 0 : getMasterUserPassword().hashCode());
hashCode = prime * hashCode + ((getOptionGroupName() == null) ? 0 : getOptionGroupName().hashCode());
hashCode = prime * hashCode + ((getPreferredBackupWindow() == null) ? 0 : getPreferredBackupWindow().hashCode());
hashCode = prime * hashCode + ((getPreferredMaintenanceWindow() == null) ? 0 : getPreferredMaintenanceWindow().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getStorageEncrypted() == null) ? 0 : getStorageEncrypted().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getEnableIAMDatabaseAuthentication() == null) ? 0 : getEnableIAMDatabaseAuthentication().hashCode());
hashCode = prime * hashCode + ((getSourceEngine() == null) ? 0 : getSourceEngine().hashCode());
hashCode = prime * hashCode + ((getSourceEngineVersion() == null) ? 0 : getSourceEngineVersion().hashCode());
hashCode = prime * hashCode + ((getS3BucketName() == null) ? 0 : getS3BucketName().hashCode());
hashCode = prime * hashCode + ((getS3Prefix() == null) ? 0 : getS3Prefix().hashCode());
hashCode = prime * hashCode + ((getS3IngestionRoleArn() == null) ? 0 : getS3IngestionRoleArn().hashCode());
hashCode = prime * hashCode + ((getBacktrackWindow() == null) ? 0 : getBacktrackWindow().hashCode());
hashCode = prime * hashCode + ((getEnableCloudwatchLogsExports() == null) ? 0 : getEnableCloudwatchLogsExports().hashCode());
hashCode = prime * hashCode + ((getDeletionProtection() == null) ? 0 : getDeletionProtection().hashCode());
hashCode = prime * hashCode + ((getCopyTagsToSnapshot() == null) ? 0 : getCopyTagsToSnapshot().hashCode());
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getDomainIAMRoleName() == null) ? 0 : getDomainIAMRoleName().hashCode());
return hashCode;
}
@Override
public RestoreDBClusterFromS3Request clone() {
return (RestoreDBClusterFromS3Request) super.clone();
}
}