Interface IncludedOauth2ProviderConfigInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IncludedOauth2ProviderConfigInput.Builder,IncludedOauth2ProviderConfigInput>, SdkBuilder<IncludedOauth2ProviderConfigInput.Builder,IncludedOauth2ProviderConfigInput>, SdkPojo
Enclosing class:
IncludedOauth2ProviderConfigInput
@Mutable @NotThreadSafe public static interface IncludedOauth2ProviderConfigInput.Builder extends SdkPojo, CopyableBuilder<IncludedOauth2ProviderConfigInput.Builder,IncludedOauth2ProviderConfigInput>

  • Method Details

    • clientId

      IncludedOauth2ProviderConfigInput.Builder clientId(String clientId)

      The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.

      Parameters:
      clientId - The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecret

      IncludedOauth2ProviderConfigInput.Builder clientSecret(String clientSecret)

      The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.

      Parameters:
      clientSecret - The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecretConfig

      IncludedOauth2ProviderConfigInput.Builder clientSecretConfig(SecretReference clientSecretConfig)

      A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

      Parameters:
      clientSecretConfig - A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecretConfig

      default IncludedOauth2ProviderConfigInput.Builder clientSecretConfig(Consumer<SecretReference.Builder> clientSecretConfig)

      A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

      This is a convenience method that creates an instance of the SecretReference.Builder avoiding the need to create one manually via SecretReference.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clientSecretConfig(SecretReference).

      Parameters:
      clientSecretConfig - a consumer that will call methods on SecretReference.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientSecretSource

      IncludedOauth2ProviderConfigInput.Builder clientSecretSource(String clientSecretSource)

      The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

      Parameters:
      clientSecretSource - The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientSecretSource

      IncludedOauth2ProviderConfigInput.Builder clientSecretSource(SecretSourceType clientSecretSource)

      The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

      Parameters:
      clientSecretSource - The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • issuer

      IncludedOauth2ProviderConfigInput.Builder issuer(String issuer)

      Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.

      Parameters:
      issuer - Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizationEndpoint

      IncludedOauth2ProviderConfigInput.Builder authorizationEndpoint(String authorizationEndpoint)

      OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.

      Parameters:
      authorizationEndpoint - OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenEndpoint

      IncludedOauth2ProviderConfigInput.Builder tokenEndpoint(String tokenEndpoint)

      OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.

      Parameters:
      tokenEndpoint - OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.