software.amazon.awssdk.services.iam.model.AccessKey Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iam Show documentation
Show all versions of iam Show documentation
The AWS Java SDK for AWS IAM module holds the client classes that are used for communicating with AWS
Identity and Access Management Service
/*
* 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.iam.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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.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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an Amazon Web Services access key.
*
*
* This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.
*
*
*
* The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret
* access key only when you first create an access key; you cannot recover the secret access key later. If you lose a
* secret access key, you must create a new access key.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AccessKey implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserName").getter(getter(AccessKey::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField ACCESS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AccessKeyId").getter(getter(AccessKey::accessKeyId)).setter(setter(Builder::accessKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessKeyId").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(AccessKey::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField SECRET_ACCESS_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SecretAccessKey").getter(getter(AccessKey::secretAccessKey)).setter(setter(Builder::secretAccessKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecretAccessKey").build()).build();
private static final SdkField CREATE_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreateDate").getter(getter(AccessKey::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(USER_NAME_FIELD,
ACCESS_KEY_ID_FIELD, STATUS_FIELD, SECRET_ACCESS_KEY_FIELD, CREATE_DATE_FIELD));
private static final long serialVersionUID = 1L;
private final String userName;
private final String accessKeyId;
private final String status;
private final String secretAccessKey;
private final Instant createDate;
private AccessKey(BuilderImpl builder) {
this.userName = builder.userName;
this.accessKeyId = builder.accessKeyId;
this.status = builder.status;
this.secretAccessKey = builder.secretAccessKey;
this.createDate = builder.createDate;
}
/**
*
* The name of the IAM user that the access key is associated with.
*
*
* @return The name of the IAM user that the access key is associated with.
*/
public final String userName() {
return userName;
}
/**
*
* The ID for this access key.
*
*
* @return The ID for this access key.
*/
public final String accessKeyId() {
return accessKeyId;
}
/**
*
* The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
* @see StatusType
*/
public final StatusType status() {
return StatusType.fromValue(status);
}
/**
*
* The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
* @see StatusType
*/
public final String statusAsString() {
return status;
}
/**
*
* The secret key used to sign requests.
*
*
* @return The secret key used to sign requests.
*/
public final String secretAccessKey() {
return secretAccessKey;
}
/**
*
* The date when the access key was created.
*
*
* @return The date when the access key was created.
*/
public final Instant createDate() {
return createDate;
}
@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(userName());
hashCode = 31 * hashCode + Objects.hashCode(accessKeyId());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(secretAccessKey());
hashCode = 31 * hashCode + Objects.hashCode(createDate());
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 AccessKey)) {
return false;
}
AccessKey other = (AccessKey) obj;
return Objects.equals(userName(), other.userName()) && Objects.equals(accessKeyId(), other.accessKeyId())
&& Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(secretAccessKey(), other.secretAccessKey()) && Objects.equals(createDate(), other.createDate());
}
/**
* 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("AccessKey").add("UserName", userName()).add("AccessKeyId", accessKeyId())
.add("Status", statusAsString())
.add("SecretAccessKey", secretAccessKey() == null ? null : "*** Sensitive Data Redacted ***")
.add("CreateDate", createDate()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "AccessKeyId":
return Optional.ofNullable(clazz.cast(accessKeyId()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "SecretAccessKey":
return Optional.ofNullable(clazz.cast(secretAccessKey()));
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AccessKey) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the IAM user that the access key is associated with.
*
*
* @param userName
* The name of the IAM user that the access key is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The ID for this access key.
*
*
* @param accessKeyId
* The ID for this access key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessKeyId(String accessKeyId);
/**
*
* The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
*
*
* @param status
* The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder status(String status);
/**
*
* The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
*
*
* @param status
* The status of the access key. Active means that the key is valid for API calls, while
* Inactive means it is not.
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder status(StatusType status);
/**
*
* The secret key used to sign requests.
*
*
* @param secretAccessKey
* The secret key used to sign requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secretAccessKey(String secretAccessKey);
/**
*
* The date when the access key was created.
*
*
* @param createDate
* The date when the access key was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createDate(Instant createDate);
}
static final class BuilderImpl implements Builder {
private String userName;
private String accessKeyId;
private String status;
private String secretAccessKey;
private Instant createDate;
private BuilderImpl() {
}
private BuilderImpl(AccessKey model) {
userName(model.userName);
accessKeyId(model.accessKeyId);
status(model.status);
secretAccessKey(model.secretAccessKey);
createDate(model.createDate);
}
public final String getUserName() {
return userName;
}
public final void setUserName(String userName) {
this.userName = userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final String getAccessKeyId() {
return accessKeyId;
}
public final void setAccessKeyId(String accessKeyId) {
this.accessKeyId = accessKeyId;
}
@Override
public final Builder accessKeyId(String accessKeyId) {
this.accessKeyId = accessKeyId;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(StatusType status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getSecretAccessKey() {
return secretAccessKey;
}
public final void setSecretAccessKey(String secretAccessKey) {
this.secretAccessKey = secretAccessKey;
}
@Override
public final Builder secretAccessKey(String secretAccessKey) {
this.secretAccessKey = secretAccessKey;
return this;
}
public final Instant getCreateDate() {
return createDate;
}
public final void setCreateDate(Instant createDate) {
this.createDate = createDate;
}
@Override
public final Builder createDate(Instant createDate) {
this.createDate = createDate;
return this;
}
@Override
public AccessKey build() {
return new AccessKey(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy