Package software.amazon.awscdk.services.iam

Class OpenIdConnectProvider.Builder

java.lang.Object
software.amazon.awscdk.services.iam.OpenIdConnectProvider.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<OpenIdConnectProvider>
Enclosing class:
OpenIdConnectProvider
@Stability(Stable) public static final class OpenIdConnectProvider.Builder extends Object implements software.amazon.jsii.Builder<OpenIdConnectProvider>
A fluent builder for OpenIdConnectProvider.

  • Method Details

    • create

      @Stability(Stable) public static OpenIdConnectProvider.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - The definition scope. This parameter is required.
      id - Construct ID. This parameter is required.
      Returns:
      a new instance of OpenIdConnectProvider.Builder.

    • url

      @Stability(Stable) public OpenIdConnectProvider.Builder url(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 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.

      Parameters:
      url - The URL of the identity provider. This parameter is required.
      Returns:
      this

    • clientIds

      @Stability(Stable) public OpenIdConnectProvider.Builder clientIds(List<String> 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.

      Default: - no clients are allowed

      Parameters:
      clientIds - A list of client IDs (also known as audiences). This parameter is required.
      Returns:
      this

    • thumbprints

      @Stability(Stable) public OpenIdConnectProvider.Builder thumbprints(List<String> 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.

      Default: - If no thumbprints are specified (an empty array or `undefined`), the thumbprint of the root certificate authority will be obtained from the provider's server as described in https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc_verify-thumbprint.html

      Parameters:
      thumbprints - A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public OpenIdConnectProvider build()
      Specified by:
      build in interface software.amazon.jsii.Builder<OpenIdConnectProvider>
      Returns:
      a newly built instance of OpenIdConnectProvider.