/* * Copyright 2018-2023 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.docdbelastic.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Returns information about a specific Elastic DocumentDB cluster. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Cluster implements Serializable, Cloneable, StructuredPojo { /** ** The name of the Elastic DocumentDB cluster administrator. *
*/ private String adminUserName; /** ** The authentication type for the Elastic DocumentDB cluster. *
*/ private String authType; /** ** The arn of the Elastic DocumentDB cluster. *
*/ private String clusterArn; /** ** The URL used to connect to the Elastic DocumentDB cluster. *
*/ private String clusterEndpoint; /** ** The name of the Elastic DocumentDB cluster. *
*/ private String clusterName; /** ** The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). *
*/ private String createTime; /** ** The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. *
*/ private String kmsKeyId; /** ** The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
* The capacity of each shard in the Elastic DocumentDB cluster. *
*/ private Integer shardCapacity; /** ** The number of shards in the Elastic DocumentDB cluster. *
*/ private Integer shardCount; /** ** The status of the Elastic DocumentDB cluster. *
*/ private String status; /** ** The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. *
*/ private java.util.List* A list of EC2 VPC security groups associated with this cluster. *
*/ private java.util.List* The name of the Elastic DocumentDB cluster administrator. *
* * @param adminUserName * The name of the Elastic DocumentDB cluster administrator. */ public void setAdminUserName(String adminUserName) { this.adminUserName = adminUserName; } /** ** The name of the Elastic DocumentDB cluster administrator. *
* * @return The name of the Elastic DocumentDB cluster administrator. */ public String getAdminUserName() { return this.adminUserName; } /** ** The name of the Elastic DocumentDB cluster administrator. *
* * @param adminUserName * The name of the Elastic DocumentDB cluster administrator. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withAdminUserName(String adminUserName) { setAdminUserName(adminUserName); return this; } /** ** The authentication type for the Elastic DocumentDB cluster. *
* * @param authType * The authentication type for the Elastic DocumentDB cluster. * @see Auth */ public void setAuthType(String authType) { this.authType = authType; } /** ** The authentication type for the Elastic DocumentDB cluster. *
* * @return The authentication type for the Elastic DocumentDB cluster. * @see Auth */ public String getAuthType() { return this.authType; } /** ** The authentication type for the Elastic DocumentDB cluster. *
* * @param authType * The authentication type for the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. * @see Auth */ public Cluster withAuthType(String authType) { setAuthType(authType); return this; } /** ** The authentication type for the Elastic DocumentDB cluster. *
* * @param authType * The authentication type for the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. * @see Auth */ public Cluster withAuthType(Auth authType) { this.authType = authType.toString(); return this; } /** ** The arn of the Elastic DocumentDB cluster. *
* * @param clusterArn * The arn of the Elastic DocumentDB cluster. */ public void setClusterArn(String clusterArn) { this.clusterArn = clusterArn; } /** ** The arn of the Elastic DocumentDB cluster. *
* * @return The arn of the Elastic DocumentDB cluster. */ public String getClusterArn() { return this.clusterArn; } /** ** The arn of the Elastic DocumentDB cluster. *
* * @param clusterArn * The arn of the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withClusterArn(String clusterArn) { setClusterArn(clusterArn); return this; } /** ** The URL used to connect to the Elastic DocumentDB cluster. *
* * @param clusterEndpoint * The URL used to connect to the Elastic DocumentDB cluster. */ public void setClusterEndpoint(String clusterEndpoint) { this.clusterEndpoint = clusterEndpoint; } /** ** The URL used to connect to the Elastic DocumentDB cluster. *
* * @return The URL used to connect to the Elastic DocumentDB cluster. */ public String getClusterEndpoint() { return this.clusterEndpoint; } /** ** The URL used to connect to the Elastic DocumentDB cluster. *
* * @param clusterEndpoint * The URL used to connect to the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withClusterEndpoint(String clusterEndpoint) { setClusterEndpoint(clusterEndpoint); return this; } /** ** The name of the Elastic DocumentDB cluster. *
* * @param clusterName * The name of the Elastic DocumentDB cluster. */ public void setClusterName(String clusterName) { this.clusterName = clusterName; } /** ** The name of the Elastic DocumentDB cluster. *
* * @return The name of the Elastic DocumentDB cluster. */ public String getClusterName() { return this.clusterName; } /** ** The name of the Elastic DocumentDB cluster. *
* * @param clusterName * The name of the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withClusterName(String clusterName) { setClusterName(clusterName); return this; } /** ** The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). *
* * @param createTime * The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). */ public void setCreateTime(String createTime) { this.createTime = createTime; } /** ** The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). *
* * @return The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). */ public String getCreateTime() { return this.createTime; } /** ** The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). *
* * @param createTime * The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC). * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withCreateTime(String createTime) { setCreateTime(createTime); return this; } /** ** The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. *
* * @param kmsKeyId * The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** ** The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. *
* * @return The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. */ public String getKmsKeyId() { return this.kmsKeyId; } /** ** The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. *
* * @param kmsKeyId * The KMS key identifier to use to encrypt the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withKmsKeyId(String kmsKeyId) { setKmsKeyId(kmsKeyId); return this; } /** ** The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*/
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
*
* Format: ddd:hh24:mi-ddd:hh24:mi
*/
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
*
* Format: ddd:hh24:mi-ddd:hh24:mi
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Cluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
setPreferredMaintenanceWindow(preferredMaintenanceWindow);
return this;
}
/**
*
* The capacity of each shard in the Elastic DocumentDB cluster. *
* * @param shardCapacity * The capacity of each shard in the Elastic DocumentDB cluster. */ public void setShardCapacity(Integer shardCapacity) { this.shardCapacity = shardCapacity; } /** ** The capacity of each shard in the Elastic DocumentDB cluster. *
* * @return The capacity of each shard in the Elastic DocumentDB cluster. */ public Integer getShardCapacity() { return this.shardCapacity; } /** ** The capacity of each shard in the Elastic DocumentDB cluster. *
* * @param shardCapacity * The capacity of each shard in the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withShardCapacity(Integer shardCapacity) { setShardCapacity(shardCapacity); return this; } /** ** The number of shards in the Elastic DocumentDB cluster. *
* * @param shardCount * The number of shards in the Elastic DocumentDB cluster. */ public void setShardCount(Integer shardCount) { this.shardCount = shardCount; } /** ** The number of shards in the Elastic DocumentDB cluster. *
* * @return The number of shards in the Elastic DocumentDB cluster. */ public Integer getShardCount() { return this.shardCount; } /** ** The number of shards in the Elastic DocumentDB cluster. *
* * @param shardCount * The number of shards in the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withShardCount(Integer shardCount) { setShardCount(shardCount); return this; } /** ** The status of the Elastic DocumentDB cluster. *
* * @param status * The status of the Elastic DocumentDB cluster. * @see Status */ public void setStatus(String status) { this.status = status; } /** ** The status of the Elastic DocumentDB cluster. *
* * @return The status of the Elastic DocumentDB cluster. * @see Status */ public String getStatus() { return this.status; } /** ** The status of the Elastic DocumentDB cluster. *
* * @param status * The status of the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. * @see Status */ public Cluster withStatus(String status) { setStatus(status); return this; } /** ** The status of the Elastic DocumentDB cluster. *
* * @param status * The status of the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. * @see Status */ public Cluster withStatus(Status status) { this.status = status.toString(); return this; } /** ** The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. *
* * @return The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. */ public java.util.List* The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. *
* * @param subnetIds * The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. */ public void setSubnetIds(java.util.Collection* The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setSubnetIds(java.util.Collection)} or {@link #withSubnetIds(java.util.Collection)} if you want to * override the existing values. *
* * @param subnetIds * The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withSubnetIds(String... subnetIds) { if (this.subnetIds == null) { setSubnetIds(new java.util.ArrayList* The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. *
* * @param subnetIds * The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withSubnetIds(java.util.Collection* A list of EC2 VPC security groups associated with this cluster. *
* * @return A list of EC2 VPC security groups associated with this cluster. */ public java.util.List* A list of EC2 VPC security groups associated with this cluster. *
* * @param vpcSecurityGroupIds * A list of EC2 VPC security groups associated with this cluster. */ public void setVpcSecurityGroupIds(java.util.Collection* A list of EC2 VPC security groups associated with this 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 associated with this cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withVpcSecurityGroupIds(String... vpcSecurityGroupIds) { if (this.vpcSecurityGroupIds == null) { setVpcSecurityGroupIds(new java.util.ArrayList* A list of EC2 VPC security groups associated with this cluster. *
* * @param vpcSecurityGroupIds * A list of EC2 VPC security groups associated with this cluster. * @return Returns a reference to this object so that method calls can be chained together. */ public Cluster withVpcSecurityGroupIds(java.util.Collection