/* * Copyright 2018-2023 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 com.amazonaws.services.identitymanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateOpenIDConnectProviderRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String url; /** *
* 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.
*
* 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. *
** 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. *
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. 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. *
*/ private com.amazonaws.internal.SdkInternalList* 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. *
*
* 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. *
* * @param url * The URL of the identity provider. The URL must begin withhttps://
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 void setUrl(String url) { this.url = url; } /** *
* 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 withhttps://
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 String getUrl() { return this.url; } /** *
* 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. *
* * @param url * The URL of the identity provider. The URL must begin withhttps://
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 Returns a reference to this object so that method calls can be chained together. */ public CreateOpenIDConnectProviderRequest withUrl(String url) { setUrl(url); return this; } /** *
* 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.
*
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
* 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
*
* 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 java.util.Listclient_id
parameter on OAuth requests.
* CreateOpenIDConnectProviderRequest
operation accepts
* client IDs up to 255 characters long.
* 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
* 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
*
* 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
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setClientIDList(java.util.Collection)} or {@link #withClientIDList(java.util.Collection)} if you want to
* override the existing values.
* CreateOpenIDConnectProviderRequest
operation
* accepts client IDs up to 255 characters long.
*/
public void setClientIDList(java.util.Collectionclient_id
parameter on OAuth requests.
* CreateOpenIDConnectProviderRequest
operation accepts
* client IDs up to 255 characters long.
* 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
* 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
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOpenIDConnectProviderRequest withClientIDList(String... clientIDList) {
if (this.clientIDList == null) {
setClientIDList(new com.amazonaws.internal.SdkInternalListclient_id
parameter on OAuth requests.
* CreateOpenIDConnectProviderRequest
operation accepts
* client IDs up to 255 characters long.
* 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
* 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.
*
* 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.
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC
* provider is
* For more information about obtaining the OIDC provider thumbprint, see Obtaining
* the thumbprint for an OpenID Connect provider in the IAM user Guide.
* CreateOpenIDConnectProviderRequest
operation
* accepts client IDs up to 255 characters long.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOpenIDConnectProviderRequest withClientIDList(java.util.Collectionserver.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.
*
* 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. *
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. 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 java.util.List
* 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.
*
* 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.
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC
* provider is
* For more information about obtaining the OIDC provider thumbprint, see Obtaining
* the thumbprint for an OpenID Connect provider in the IAM user Guide.
* 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.
*
* 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. *
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. 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 void setThumbprintList(java.util.Collection
* 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.
*
* 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.
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC
* provider is
* For more information about obtaining the OIDC provider thumbprint, see Obtaining
* the thumbprint for an OpenID Connect provider in the IAM user Guide.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setThumbprintList(java.util.Collection)} or {@link #withThumbprintList(java.util.Collection)} if you want
* to override the existing values.
* 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.
*
* 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. *
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOpenIDConnectProviderRequest withThumbprintList(String... thumbprintList) {
if (this.thumbprintList == null) {
setThumbprintList(new com.amazonaws.internal.SdkInternalList
* 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.
*
* 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.
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC
* provider is
* For more information about obtaining the OIDC provider thumbprint, see Obtaining
* the thumbprint for an OpenID Connect provider in the IAM user Guide.
* 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.
*
* 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. *
*
* You must provide at least one thumbprint when creating an IAM OIDC provider. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOpenIDConnectProviderRequest withThumbprintList(java.util.Collection
* 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.
*
* 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 java.util.List* 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. *
** 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 void setTags(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * 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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateOpenIDConnectProviderRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new com.amazonaws.internal.SdkInternalList* 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. *
** 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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateOpenIDConnectProviderRequest withTags(java.util.Collection