software.amazon.awssdk.services.imagebuilder.model.InstanceMetadataOptions 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.imagebuilder.model;
import java.io.Serializable;
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;
/**
*
* The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test
* instances. For more information about instance metadata options, see Configure the
* instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure
* the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InstanceMetadataOptions implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField HTTP_TOKENS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("httpTokens").getter(getter(InstanceMetadataOptions::httpTokens)).setter(setter(Builder::httpTokens))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("httpTokens").build()).build();
private static final SdkField HTTP_PUT_RESPONSE_HOP_LIMIT_FIELD = SdkField
. builder(MarshallingType.INTEGER).memberName("httpPutResponseHopLimit")
.getter(getter(InstanceMetadataOptions::httpPutResponseHopLimit)).setter(setter(Builder::httpPutResponseHopLimit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("httpPutResponseHopLimit").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(HTTP_TOKENS_FIELD,
HTTP_PUT_RESPONSE_HOP_LIMIT_FIELD));
private static final long serialVersionUID = 1L;
private final String httpTokens;
private final Integer httpPutResponseHopLimit;
private InstanceMetadataOptions(BuilderImpl builder) {
this.httpTokens = builder.httpTokens;
this.httpPutResponseHopLimit = builder.httpPutResponseHopLimit;
}
/**
*
* Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect
* the response as follows:
*
*
* -
*
* required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
*
*
* -
*
* optional – You can include a signed token header in your request to retrieve instance metadata, or you can
* leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0
* credentials are returned.
*
*
*
*
* The default setting is optional.
*
*
* @return Indicates whether a signed token header is required for instance metadata retrieval requests. The values
* affect the response as follows:
*
* -
*
* required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all
* cases.
*
*
* -
*
* optional – You can include a signed token header in your request to retrieve instance metadata, or
* you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role.
* Otherwise, version 1.0 credentials are returned.
*
*
*
*
* The default setting is optional.
*/
public final String httpTokens() {
return httpTokens;
}
/**
*
* Limit the number of hops that an instance metadata request can traverse to reach its destination.
*
*
* @return Limit the number of hops that an instance metadata request can traverse to reach its destination.
*/
public final Integer httpPutResponseHopLimit() {
return httpPutResponseHopLimit;
}
@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(httpTokens());
hashCode = 31 * hashCode + Objects.hashCode(httpPutResponseHopLimit());
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 InstanceMetadataOptions)) {
return false;
}
InstanceMetadataOptions other = (InstanceMetadataOptions) obj;
return Objects.equals(httpTokens(), other.httpTokens())
&& Objects.equals(httpPutResponseHopLimit(), other.httpPutResponseHopLimit());
}
/**
* 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("InstanceMetadataOptions").add("HttpTokens", httpTokens())
.add("HttpPutResponseHopLimit", httpPutResponseHopLimit()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "httpTokens":
return Optional.ofNullable(clazz.cast(httpTokens()));
case "httpPutResponseHopLimit":
return Optional.ofNullable(clazz.cast(httpPutResponseHopLimit()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InstanceMetadataOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Indicates whether a signed token header is required for instance metadata retrieval requests. The values
* affect the response as follows:
*
*
* -
*
* required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all
* cases.
*
*
* -
*
* optional – You can include a signed token header in your request to retrieve instance metadata, or you
* can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise,
* version 1.0 credentials are returned.
*
*
*
*
* The default setting is optional.
*
*
* @param httpTokens
* Indicates whether a signed token header is required for instance metadata retrieval requests. The
* values affect the response as follows:
*
* -
*
* required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in
* all cases.
*
*
* -
*
* optional – You can include a signed token header in your request to retrieve instance metadata,
* or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role.
* Otherwise, version 1.0 credentials are returned.
*
*
*
*
* The default setting is optional.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder httpTokens(String httpTokens);
/**
*
* Limit the number of hops that an instance metadata request can traverse to reach its destination.
*
*
* @param httpPutResponseHopLimit
* Limit the number of hops that an instance metadata request can traverse to reach its destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder httpPutResponseHopLimit(Integer httpPutResponseHopLimit);
}
static final class BuilderImpl implements Builder {
private String httpTokens;
private Integer httpPutResponseHopLimit;
private BuilderImpl() {
}
private BuilderImpl(InstanceMetadataOptions model) {
httpTokens(model.httpTokens);
httpPutResponseHopLimit(model.httpPutResponseHopLimit);
}
public final String getHttpTokens() {
return httpTokens;
}
public final void setHttpTokens(String httpTokens) {
this.httpTokens = httpTokens;
}
@Override
public final Builder httpTokens(String httpTokens) {
this.httpTokens = httpTokens;
return this;
}
public final Integer getHttpPutResponseHopLimit() {
return httpPutResponseHopLimit;
}
public final void setHttpPutResponseHopLimit(Integer httpPutResponseHopLimit) {
this.httpPutResponseHopLimit = httpPutResponseHopLimit;
}
@Override
public final Builder httpPutResponseHopLimit(Integer httpPutResponseHopLimit) {
this.httpPutResponseHopLimit = httpPutResponseHopLimit;
return this;
}
@Override
public InstanceMetadataOptions build() {
return new InstanceMetadataOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}