Class CreateOpenIdConnectProviderRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.iam.model.IamRequest
-
- software.amazon.awssdk.services.iam.model.CreateOpenIdConnectProviderRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateOpenIdConnectProviderRequest.Builder,CreateOpenIdConnectProviderRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOpenIdConnectProviderRequest extends IamRequest implements ToCopyableBuilder<CreateOpenIdConnectProviderRequest.Builder,CreateOpenIdConnectProviderRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateOpenIdConnectProviderRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateOpenIdConnectProviderRequest.Builder
builder()
List<String>
clientIDList()
Provides a list of client IDs, also known as audiences.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasClientIDList()
For responses, this returns true if the service returned a value for the ClientIDList property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.boolean
hasThumbprintList()
For responses, this returns true if the service returned a value for the ThumbprintList property.List<SdkField<?>>
sdkFields()
static Class<? extends CreateOpenIdConnectProviderRequest.Builder>
serializableBuilderClass()
List<Tag>
tags()
A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider.List<String>
thumbprintList()
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates.CreateOpenIdConnectProviderRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
url()
The URL of the identity provider.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
url
public final String url()
The URL of the identity provider. The URL must begin with
https://
and should correspond to theiss
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, likehttps://server.example.org
orhttps://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.
- Returns:
- The URL of the identity provider. The URL must begin with
https://
and should correspond to theiss
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, likehttps://server.example.org
orhttps://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.
-
hasClientIDList
public final boolean hasClientIDList()
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 theisEmpty()
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.
-
clientIDList
public final List<String> clientIDList()
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
hasClientIDList()
method.- Returns:
- 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.
-
hasThumbprintList
public final boolean hasThumbprintList()
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 theisEmpty()
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.
-
thumbprintList
public final List<String> thumbprintList()
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 byhttps://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
hasThumbprintList()
method.- Returns:
- 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 byhttps://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.
-
hasTags
public final boolean hasTags()
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 theisEmpty()
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.
-
tags
public final List<Tag> 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.
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
hasTags()
method.- Returns:
- 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.
-
toBuilder
public CreateOpenIdConnectProviderRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateOpenIdConnectProviderRequest.Builder,CreateOpenIdConnectProviderRequest>
- Specified by:
toBuilder
in classIamRequest
-
builder
public static CreateOpenIdConnectProviderRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateOpenIdConnectProviderRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-