software.amazon.awssdk.services.iam.model.CreateOpenIdConnectProviderRequest Maven / Gradle / Ivy
Show all versions of iam 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.iam.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 CreateOpenIdConnectProviderRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField URL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Url")
.getter(getter(CreateOpenIdConnectProviderRequest::url)).setter(setter(Builder::url))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Url").build()).build();
private static final SdkField> CLIENT_ID_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ClientIDList")
.getter(getter(CreateOpenIdConnectProviderRequest::clientIDList))
.setter(setter(Builder::clientIDList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientIDList").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> THUMBPRINT_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ThumbprintList")
.getter(getter(CreateOpenIdConnectProviderRequest::thumbprintList))
.setter(setter(Builder::thumbprintList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ThumbprintList").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> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateOpenIdConnectProviderRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(URL_FIELD,
CLIENT_ID_LIST_FIELD, THUMBPRINT_LIST_FIELD, TAGS_FIELD));
private final String url;
private final List clientIDList;
private final List thumbprintList;
private final List tags;
private CreateOpenIdConnectProviderRequest(BuilderImpl builder) {
super(builder);
this.url = builder.url;
this.clientIDList = builder.clientIDList;
this.thumbprintList = builder.thumbprintList;
this.tags = builder.tags;
}
/**
*
* The URL of the identity provider. The URL must begin with https://
and should correspond to the
* iss
claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are
* allowed but query parameters are not. Typically the URL consists of only a hostname, like
* https://server.example.org
or https://example.com
. The URL should not contain a port
* number.
*
*
* You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to
* submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you
* will get an error.
*
*
* @return The URL of the identity provider. The URL must begin with https://
and should correspond to
* the iss
claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path
* components are allowed but query parameters are not. Typically the URL consists of only a hostname, like
* https://server.example.org
or https://example.com
. The URL should not contain a
* port number.
*
* You cannot register the same provider multiple times in a single Amazon Web Services account. If you try
* to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services
* account, you will get an error.
*/
public final String url() {
return url;
}
/**
* For responses, this returns true if the service returned a value for the ClientIDList 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 hasClientIDList() {
return clientIDList != null && !(clientIDList instanceof SdkAutoConstructList);
}
/**
*
* Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect
* provider, they establish a value that identifies the application. This is the value that's sent as the
* client_id
parameter on OAuth requests.
*
*
* You can register multiple client IDs with the same provider. For example, you might have multiple applications
* that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest
operation accepts
* client IDs up to 255 characters long.
*
*
* 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 #hasClientIDList} method.
*
*
* @return Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID
* Connect provider, they establish a value that identifies the application. This is the value that's sent
* as the client_id
parameter on OAuth requests.
*
* You can register multiple client IDs with the same provider. For example, you might have multiple
* applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single
* IAM OIDC provider.
*
*
* There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest
operation
* accepts client IDs up to 255 characters long.
*/
public final List clientIDList() {
return clientIDList;
}
/**
* For responses, this returns true if the service returned a value for the ThumbprintList 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 hasThumbprintList() {
return thumbprintList != null && !(thumbprintList instanceof SdkAutoConstructList);
}
/**
*
* A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates.
* Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC
* provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
*
*
* This parameter is optional. If it is not included, IAM will retrieve and use the top intermediate certificate
* authority (CA) thumbprint of the OpenID Connect identity provider server certificate.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain
* where the OpenID Connect provider makes its keys available. It is always a 40-character string.
*
*
* For example, assume that the OIDC provider is server.example.com
and the provider stores its keys at
* https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded
* SHA-1 hash value of the certificate used by https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider thumbprint, see Obtaining
* the thumbprint for an OpenID Connect provider in the IAM user Guide.
*
*
* 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 #hasThumbprintList} method.
*
*
* @return A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server
* certificates. Typically this list includes only one entry. However, IAM lets you have up to five
* thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is
* rotating certificates.
*
* This parameter is optional. If it is not included, IAM will retrieve and use the top intermediate
* certificate authority (CA) thumbprint of the OpenID Connect identity provider server certificate.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by
* the domain where the OpenID Connect provider makes its keys available. It is always a 40-character
* string.
*
*
* For example, assume that the OIDC provider is server.example.com
and the provider stores its
* keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the
* hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.
*/
public final List thumbprintList() {
return thumbprintList;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key
* name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* 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 #hasTags} method.
*
*
* @return A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists
* of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(url());
hashCode = 31 * hashCode + Objects.hashCode(hasClientIDList() ? clientIDList() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasThumbprintList() ? thumbprintList() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateOpenIdConnectProviderRequest)) {
return false;
}
CreateOpenIdConnectProviderRequest other = (CreateOpenIdConnectProviderRequest) obj;
return Objects.equals(url(), other.url()) && hasClientIDList() == other.hasClientIDList()
&& Objects.equals(clientIDList(), other.clientIDList()) && hasThumbprintList() == other.hasThumbprintList()
&& Objects.equals(thumbprintList(), other.thumbprintList()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateOpenIdConnectProviderRequest").add("Url", url())
.add("ClientIDList", hasClientIDList() ? clientIDList() : null)
.add("ThumbprintList", hasThumbprintList() ? thumbprintList() : null).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Url":
return Optional.ofNullable(clazz.cast(url()));
case "ClientIDList":
return Optional.ofNullable(clazz.cast(clientIDList()));
case "ThumbprintList":
return Optional.ofNullable(clazz.cast(thumbprintList()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function