software.amazon.awssdk.services.cloudhsmv2.model.CreateClusterRequest Maven / Gradle / Ivy
Show all versions of cloudhsmv2 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudhsmv2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateClusterRequest extends CloudHsmV2Request implements
ToCopyableBuilder {
private static final SdkField BACKUP_RETENTION_POLICY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("BackupRetentionPolicy")
.getter(getter(CreateClusterRequest::backupRetentionPolicy)).setter(setter(Builder::backupRetentionPolicy))
.constructor(BackupRetentionPolicy::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BackupRetentionPolicy").build())
.build();
private static final SdkField HSM_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HsmType").getter(getter(CreateClusterRequest::hsmType)).setter(setter(Builder::hsmType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HsmType").build()).build();
private static final SdkField SOURCE_BACKUP_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceBackupId").getter(getter(CreateClusterRequest::sourceBackupId))
.setter(setter(Builder::sourceBackupId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceBackupId").build()).build();
private static final SdkField> SUBNET_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SubnetIds")
.getter(getter(CreateClusterRequest::subnetIds))
.setter(setter(Builder::subnetIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAG_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagList")
.getter(getter(CreateClusterRequest::tagList))
.setter(setter(Builder::tagList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MODE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Mode")
.getter(getter(CreateClusterRequest::modeAsString)).setter(setter(Builder::mode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Mode").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BACKUP_RETENTION_POLICY_FIELD,
HSM_TYPE_FIELD, SOURCE_BACKUP_ID_FIELD, SUBNET_IDS_FIELD, TAG_LIST_FIELD, MODE_FIELD));
private final BackupRetentionPolicy backupRetentionPolicy;
private final String hsmType;
private final String sourceBackupId;
private final List subnetIds;
private final List tagList;
private final String mode;
private CreateClusterRequest(BuilderImpl builder) {
super(builder);
this.backupRetentionPolicy = builder.backupRetentionPolicy;
this.hsmType = builder.hsmType;
this.sourceBackupId = builder.sourceBackupId;
this.subnetIds = builder.subnetIds;
this.tagList = builder.tagList;
this.mode = builder.mode;
}
/**
*
* A policy that defines how the service retains backups.
*
*
* @return A policy that defines how the service retains backups.
*/
public final BackupRetentionPolicy backupRetentionPolicy() {
return backupRetentionPolicy;
}
/**
*
* The type of HSM to use in the cluster. The allowed values are hsm1.medium and
* hsm2m.medium.
*
*
* @return The type of HSM to use in the cluster. The allowed values are hsm1.medium and
* hsm2m.medium.
*/
public final String hsmType() {
return hsmType;
}
/**
*
* The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore
* the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use
* DescribeBackups. If using a backup in another account, the full ARN must be supplied.
*
*
* @return The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to
* restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use
* DescribeBackups. If using a backup in another account, the full ARN must be supplied.
*/
public final String sourceBackupId() {
return sourceBackupId;
}
/**
* For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasSubnetIds() {
return subnetIds != null && !(subnetIds instanceof SdkAutoConstructList);
}
/**
*
* The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If
* you specify multiple subnets, they must meet the following criteria:
*
*
* -
*
* All subnets must be in the same virtual private cloud (VPC).
*
*
* -
*
* You can specify only one subnet per Availability Zone.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSubnetIds} method.
*
*
* @return The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one
* subnet. If you specify multiple subnets, they must meet the following criteria:
*
* -
*
* All subnets must be in the same virtual private cloud (VPC).
*
*
* -
*
* You can specify only one subnet per Availability Zone.
*
*
*/
public final List subnetIds() {
return subnetIds;
}
/**
* For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasTagList() {
return tagList != null && !(tagList instanceof SdkAutoConstructList);
}
/**
*
* Tags to apply to the CloudHSM cluster during creation.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTagList} method.
*
*
* @return Tags to apply to the CloudHSM cluster during creation.
*/
public final List tagList() {
return tagList;
}
/**
*
* The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link ClusterMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
* @see ClusterMode
*/
public final ClusterMode mode() {
return ClusterMode.fromValue(mode);
}
/**
*
* The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link ClusterMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
* @see ClusterMode
*/
public final String modeAsString() {
return mode;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(backupRetentionPolicy());
hashCode = 31 * hashCode + Objects.hashCode(hsmType());
hashCode = 31 * hashCode + Objects.hashCode(sourceBackupId());
hashCode = 31 * hashCode + Objects.hashCode(hasSubnetIds() ? subnetIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTagList() ? tagList() : null);
hashCode = 31 * hashCode + Objects.hashCode(modeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateClusterRequest)) {
return false;
}
CreateClusterRequest other = (CreateClusterRequest) obj;
return Objects.equals(backupRetentionPolicy(), other.backupRetentionPolicy())
&& Objects.equals(hsmType(), other.hsmType()) && Objects.equals(sourceBackupId(), other.sourceBackupId())
&& hasSubnetIds() == other.hasSubnetIds() && Objects.equals(subnetIds(), other.subnetIds())
&& hasTagList() == other.hasTagList() && Objects.equals(tagList(), other.tagList())
&& Objects.equals(modeAsString(), other.modeAsString());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("CreateClusterRequest").add("BackupRetentionPolicy", backupRetentionPolicy())
.add("HsmType", hsmType()).add("SourceBackupId", sourceBackupId())
.add("SubnetIds", hasSubnetIds() ? subnetIds() : null).add("TagList", hasTagList() ? tagList() : null)
.add("Mode", modeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BackupRetentionPolicy":
return Optional.ofNullable(clazz.cast(backupRetentionPolicy()));
case "HsmType":
return Optional.ofNullable(clazz.cast(hsmType()));
case "SourceBackupId":
return Optional.ofNullable(clazz.cast(sourceBackupId()));
case "SubnetIds":
return Optional.ofNullable(clazz.cast(subnetIds()));
case "TagList":
return Optional.ofNullable(clazz.cast(tagList()));
case "Mode":
return Optional.ofNullable(clazz.cast(modeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateClusterRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudHsmV2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* A policy that defines how the service retains backups.
*
*
* @param backupRetentionPolicy
* A policy that defines how the service retains backups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder backupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy);
/**
*
* A policy that defines how the service retains backups.
*
* This is a convenience method that creates an instance of the {@link BackupRetentionPolicy.Builder} avoiding
* the need to create one manually via {@link BackupRetentionPolicy#builder()}.
*
*
* When the {@link Consumer} completes, {@link BackupRetentionPolicy.Builder#build()} is called immediately and
* its result is passed to {@link #backupRetentionPolicy(BackupRetentionPolicy)}.
*
* @param backupRetentionPolicy
* a consumer that will call methods on {@link BackupRetentionPolicy.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #backupRetentionPolicy(BackupRetentionPolicy)
*/
default Builder backupRetentionPolicy(Consumer backupRetentionPolicy) {
return backupRetentionPolicy(BackupRetentionPolicy.builder().applyMutation(backupRetentionPolicy).build());
}
/**
*
* The type of HSM to use in the cluster. The allowed values are hsm1.medium and
* hsm2m.medium.
*
*
* @param hsmType
* The type of HSM to use in the cluster. The allowed values are hsm1.medium and
* hsm2m.medium.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hsmType(String hsmType);
/**
*
* The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to
* restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use
* DescribeBackups. If using a backup in another account, the full ARN must be supplied.
*
*
* @param sourceBackupId
* The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value
* to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN,
* use DescribeBackups. If using a backup in another account, the full ARN must be
* supplied.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceBackupId(String sourceBackupId);
/**
*
* The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one
* subnet. If you specify multiple subnets, they must meet the following criteria:
*
*
* -
*
* All subnets must be in the same virtual private cloud (VPC).
*
*
* -
*
* You can specify only one subnet per Availability Zone.
*
*
*
*
* @param subnetIds
* The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one
* subnet. If you specify multiple subnets, they must meet the following criteria:
*
* -
*
* All subnets must be in the same virtual private cloud (VPC).
*
*
* -
*
* You can specify only one subnet per Availability Zone.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(Collection subnetIds);
/**
*
* The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one
* subnet. If you specify multiple subnets, they must meet the following criteria:
*
*
* -
*
* All subnets must be in the same virtual private cloud (VPC).
*
*
* -
*
* You can specify only one subnet per Availability Zone.
*
*
*
*
* @param subnetIds
* The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one
* subnet. If you specify multiple subnets, they must meet the following criteria:
*
* -
*
* All subnets must be in the same virtual private cloud (VPC).
*
*
* -
*
* You can specify only one subnet per Availability Zone.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(String... subnetIds);
/**
*
* Tags to apply to the CloudHSM cluster during creation.
*
*
* @param tagList
* Tags to apply to the CloudHSM cluster during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagList(Collection tagList);
/**
*
* Tags to apply to the CloudHSM cluster during creation.
*
*
* @param tagList
* Tags to apply to the CloudHSM cluster during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagList(Tag... tagList);
/**
*
* Tags to apply to the CloudHSM cluster during creation.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudhsmv2.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.cloudhsmv2.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudhsmv2.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tagList(List)}.
*
* @param tagList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudhsmv2.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tagList(java.util.Collection)
*/
Builder tagList(Consumer... tagList);
/**
*
* The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
*
*
* @param mode
* The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
* @see ClusterMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterMode
*/
Builder mode(String mode);
/**
*
* The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
*
*
* @param mode
* The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
* @see ClusterMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterMode
*/
Builder mode(ClusterMode mode);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudHsmV2Request.BuilderImpl implements Builder {
private BackupRetentionPolicy backupRetentionPolicy;
private String hsmType;
private String sourceBackupId;
private List subnetIds = DefaultSdkAutoConstructList.getInstance();
private List tagList = DefaultSdkAutoConstructList.getInstance();
private String mode;
private BuilderImpl() {
}
private BuilderImpl(CreateClusterRequest model) {
super(model);
backupRetentionPolicy(model.backupRetentionPolicy);
hsmType(model.hsmType);
sourceBackupId(model.sourceBackupId);
subnetIds(model.subnetIds);
tagList(model.tagList);
mode(model.mode);
}
public final BackupRetentionPolicy.Builder getBackupRetentionPolicy() {
return backupRetentionPolicy != null ? backupRetentionPolicy.toBuilder() : null;
}
public final void setBackupRetentionPolicy(BackupRetentionPolicy.BuilderImpl backupRetentionPolicy) {
this.backupRetentionPolicy = backupRetentionPolicy != null ? backupRetentionPolicy.build() : null;
}
@Override
public final Builder backupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy) {
this.backupRetentionPolicy = backupRetentionPolicy;
return this;
}
public final String getHsmType() {
return hsmType;
}
public final void setHsmType(String hsmType) {
this.hsmType = hsmType;
}
@Override
public final Builder hsmType(String hsmType) {
this.hsmType = hsmType;
return this;
}
public final String getSourceBackupId() {
return sourceBackupId;
}
public final void setSourceBackupId(String sourceBackupId) {
this.sourceBackupId = sourceBackupId;
}
@Override
public final Builder sourceBackupId(String sourceBackupId) {
this.sourceBackupId = sourceBackupId;
return this;
}
public final Collection getSubnetIds() {
if (subnetIds instanceof SdkAutoConstructList) {
return null;
}
return subnetIds;
}
public final void setSubnetIds(Collection subnetIds) {
this.subnetIds = SubnetIdsCopier.copy(subnetIds);
}
@Override
public final Builder subnetIds(Collection subnetIds) {
this.subnetIds = SubnetIdsCopier.copy(subnetIds);
return this;
}
@Override
@SafeVarargs
public final Builder subnetIds(String... subnetIds) {
subnetIds(Arrays.asList(subnetIds));
return this;
}
public final List getTagList() {
List result = TagListCopier.copyToBuilder(this.tagList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTagList(Collection tagList) {
this.tagList = TagListCopier.copyFromBuilder(tagList);
}
@Override
public final Builder tagList(Collection tagList) {
this.tagList = TagListCopier.copy(tagList);
return this;
}
@Override
@SafeVarargs
public final Builder tagList(Tag... tagList) {
tagList(Arrays.asList(tagList));
return this;
}
@Override
@SafeVarargs
public final Builder tagList(Consumer... tagList) {
tagList(Stream.of(tagList).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getMode() {
return mode;
}
public final void setMode(String mode) {
this.mode = mode;
}
@Override
public final Builder mode(String mode) {
this.mode = mode;
return this;
}
@Override
public final Builder mode(ClusterMode mode) {
this.mode(mode == null ? null : mode.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateClusterRequest build() {
return new CreateClusterRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}