@Generated(value="software.amazon.awssdk:codegen") public final class CreateOpenIdConnectProviderRequest extends IamRequest implements ToCopyableBuilder<CreateOpenIdConnectProviderRequest.Builder,CreateOpenIdConnectProviderRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateOpenIdConnectProviderRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateOpenIdConnectProviderRequest.Builder |
builder() |
List<String> |
clientIDList()
A list of client IDs (also known as audiences).
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
static Class<? extends CreateOpenIdConnectProviderRequest.Builder> |
serializableBuilderClass() |
List<String> |
thumbprintList()
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
|
CreateOpenIdConnectProviderRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
url()
The URL of the identity provider.
|
overrideConfiguration
copy
public String 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 host name, like
"https://server.example.org" or "https://example.com".
You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
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 host name, like
"https://server.example.org" or "https://example.com".
You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
public List<String> clientIDList()
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
action accepts
client IDs up to 255 characters long.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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
action
accepts client IDs up to 255 characters long.
public List<String> thumbprintList()
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). 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, if the OIDC provider is
server.example.com
and the provider stores its keys at
"https://keys.server.example.com/openid-connect", 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's 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.
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, if the OIDC
provider is server.example.com
and the provider stores its keys at
"https://keys.server.example.com/openid-connect", 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's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.
public CreateOpenIdConnectProviderRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateOpenIdConnectProviderRequest.Builder,CreateOpenIdConnectProviderRequest>
toBuilder
in class IamRequest
public static CreateOpenIdConnectProviderRequest.Builder builder()
public static Class<? extends CreateOpenIdConnectProviderRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.