software.amazon.awssdk.services.accessanalyzer.model.RdsDbClusterSnapshotConfiguration Maven / Gradle / Ivy
/*
* 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.accessanalyzer.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
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.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The proposed access control configuration for an Amazon RDS DB cluster snapshot. You can propose a configuration for
* a new Amazon RDS DB cluster snapshot or an Amazon RDS DB cluster snapshot that you own by specifying the
* RdsDbClusterSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBClusterSnapshotAttribute.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RdsDbClusterSnapshotConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("attributes")
.getter(getter(RdsDbClusterSnapshotConfiguration::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("attributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RdsDbClusterSnapshotAttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("kmsKeyId").getter(getter(RdsDbClusterSnapshotConfiguration::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("kmsKeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTES_FIELD,
KMS_KEY_ID_FIELD));
private static final long serialVersionUID = 1L;
private final Map attributes;
private final String kmsKeyId;
private RdsDbClusterSnapshotConfiguration(BuilderImpl builder) {
this.attributes = builder.attributes;
this.kmsKeyId = builder.kmsKeyId;
}
/**
* For responses, this returns true if the service returned a value for the Attributes 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 hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* The names and values of manual DB cluster snapshot attributes. Manual DB cluster snapshot attributes are used to
* authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. The only valid value for
* AttributeName for the attribute map is restore
*
*
* 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 #hasAttributes} method.
*
*
* @return The names and values of manual DB cluster snapshot attributes. Manual DB cluster snapshot attributes are
* used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. The only
* valid value for AttributeName for the attribute map is restore
*/
public final Map attributes() {
return attributes;
}
/**
*
* The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS key identifier is the key ARN,
* key ID, alias ARN, or alias name for the KMS key.
*
*
* -
*
* If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the
* kmsKeyId, or you specify an empty string, then the access preview uses the existing
* kmsKeyId of the snapshot.
*
*
* -
*
* If the access preview is for a new resource and you do not specify the specify the kmsKeyId, then
* the access preview considers the snapshot as unencrypted.
*
*
*
*
* @return The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS key identifier is the key
* ARN, key ID, alias ARN, or alias name for the KMS key.
*
* -
*
* If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the
* kmsKeyId, or you specify an empty string, then the access preview uses the existing
* kmsKeyId of the snapshot.
*
*
* -
*
* If the access preview is for a new resource and you do not specify the specify the kmsKeyId,
* then the access preview considers the snapshot as unencrypted.
*
*
*/
public final String kmsKeyId() {
return kmsKeyId;
}
@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 + Objects.hashCode(hasAttributes() ? attributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RdsDbClusterSnapshotConfiguration)) {
return false;
}
RdsDbClusterSnapshotConfiguration other = (RdsDbClusterSnapshotConfiguration) obj;
return hasAttributes() == other.hasAttributes() && Objects.equals(attributes(), other.attributes())
&& Objects.equals(kmsKeyId(), other.kmsKeyId());
}
/**
* 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("RdsDbClusterSnapshotConfiguration").add("Attributes", hasAttributes() ? attributes() : null)
.add("KmsKeyId", kmsKeyId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "kmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RdsDbClusterSnapshotConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The names and values of manual DB cluster snapshot attributes. Manual DB cluster snapshot attributes are used
* to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. The only valid value
* for AttributeName for the attribute map is restore
*
*
* @param attributes
* The names and values of manual DB cluster snapshot attributes. Manual DB cluster snapshot attributes
* are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. The
* only valid value for AttributeName for the attribute map is restore
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
/**
*
* The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS key identifier is the key
* ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* -
*
* If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the
* kmsKeyId, or you specify an empty string, then the access preview uses the existing
* kmsKeyId of the snapshot.
*
*
* -
*
* If the access preview is for a new resource and you do not specify the specify the kmsKeyId,
* then the access preview considers the snapshot as unencrypted.
*
*
*
*
* @param kmsKeyId
* The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS key identifier is the
* key ARN, key ID, alias ARN, or alias name for the KMS key.
*
* -
*
* If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the
* kmsKeyId, or you specify an empty string, then the access preview uses the existing
* kmsKeyId of the snapshot.
*
*
* -
*
* If the access preview is for a new resource and you do not specify the specify the
* kmsKeyId, then the access preview considers the snapshot as unencrypted.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
}
static final class BuilderImpl implements Builder {
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private String kmsKeyId;
private BuilderImpl() {
}
private BuilderImpl(RdsDbClusterSnapshotConfiguration model) {
attributes(model.attributes);
kmsKeyId(model.kmsKeyId);
}
public final Map getAttributes() {
Map result = RdsDbClusterSnapshotAttributesMapCopier
.copyToBuilder(this.attributes);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setAttributes(Map attributes) {
this.attributes = RdsDbClusterSnapshotAttributesMapCopier.copyFromBuilder(attributes);
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = RdsDbClusterSnapshotAttributesMapCopier.copy(attributes);
return this;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
@Override
public RdsDbClusterSnapshotConfiguration build() {
return new RdsDbClusterSnapshotConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}