software.amazon.awscdk.services.iam

Class OpenIdConnectProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.iam.OpenIdConnectProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenIdConnectProviderProps>

Enclosing interface:

OpenIdConnectProviderProps

@Stability(value=Stable)
public static final class OpenIdConnectProviderProps.Builder
extends Object
implements software.amazon.jsii.Builder<OpenIdConnectProviderProps>

A builder for OpenIdConnectProviderProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OpenIdConnectProviderProps	build() Builds the configured instance.
OpenIdConnectProviderProps.Builder	clientIds(List<String> clientIds) Sets the value of OpenIdConnectProviderProps.getClientIds()
OpenIdConnectProviderProps.Builder	thumbprints(List<String> thumbprints) Sets the value of OpenIdConnectProviderProps.getThumbprints()
OpenIdConnectProviderProps.Builder	url(String url) Sets the value of OpenIdConnectProviderProps.getUrl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

url

@Stability(value=Stable)
public OpenIdConnectProviderProps.Builder url(String url)

Sets the value of OpenIdConnectProviderProps.getUrl()

Parameters:

url - The URL of the identity provider. This parameter is required. 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.

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.

Returns:

this

clientIds

@Stability(value=Stable)
public OpenIdConnectProviderProps.Builder clientIds(List<String> clientIds)

Sets the value of OpenIdConnectProviderProps.getClientIds()

Parameters:

clientIds - 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.

Client IDs are up to 255 characters long.

Returns:

this

thumbprints

@Stability(value=Stable)
public OpenIdConnectProviderProps.Builder thumbprints(List<String> thumbprints)

Sets the value of OpenIdConnectProviderProps.getThumbprints()

Parameters:

thumbprints - 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.

Returns:

this

build

@Stability(value=Stable)
public OpenIdConnectProviderProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<OpenIdConnectProviderProps>

Returns:

a new instance of OpenIdConnectProviderProps

Throws:

NullPointerException - if any required attribute was not provided