Interface CustomOauth2ProviderConfigInput.Builder

  • Method Details

    • oauthDiscovery

      The OAuth2 discovery information for the custom provider.

      Parameters:
      oauthDiscovery - The OAuth2 discovery information for the custom provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • oauthDiscovery

      The OAuth2 discovery information for the custom provider.

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

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

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

      The client ID for the custom OAuth2 provider.

      Parameters:
      clientId - The client ID for the custom OAuth2 provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientSecret

      CustomOauth2ProviderConfigInput.Builder clientSecret(String clientSecret)

      The client secret for the custom OAuth2 provider.

      Parameters:
      clientSecret - The client secret for the custom OAuth2 provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientSecretConfig

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

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

      CustomOauth2ProviderConfigInput.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:
    • onBehalfOfTokenExchangeConfig

      CustomOauth2ProviderConfigInput.Builder onBehalfOfTokenExchangeConfig(OnBehalfOfTokenExchangeConfigType onBehalfOfTokenExchangeConfig)

      The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.

      Parameters:
      onBehalfOfTokenExchangeConfig - The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • onBehalfOfTokenExchangeConfig

      default CustomOauth2ProviderConfigInput.Builder onBehalfOfTokenExchangeConfig(Consumer<OnBehalfOfTokenExchangeConfigType.Builder> onBehalfOfTokenExchangeConfig)

      The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.

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

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

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

      CustomOauth2ProviderConfigInput.Builder clientAuthenticationMethod(String clientAuthenticationMethod)

      The client authentication method to use when authenticating with the token endpoint.

      Parameters:
      clientAuthenticationMethod - The client authentication method to use when authenticating with the token endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • clientAuthenticationMethod

      CustomOauth2ProviderConfigInput.Builder clientAuthenticationMethod(ClientAuthenticationMethodType clientAuthenticationMethod)

      The client authentication method to use when authenticating with the token endpoint.

      Parameters:
      clientAuthenticationMethod - The client authentication method to use when authenticating with the token endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • privateKeyJwtConfig

      CustomOauth2ProviderConfigInput.Builder privateKeyJwtConfig(PrivateKeyJwtConfig privateKeyJwtConfig)

      The private_key_jwt client authentication configuration for this credential provider. When specified, the credential provider uses JWT client assertions to authenticate with the token endpoint.

      Parameters:
      privateKeyJwtConfig - The private_key_jwt client authentication configuration for this credential provider. When specified, the credential provider uses JWT client assertions to authenticate with the token endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privateKeyJwtConfig

      default CustomOauth2ProviderConfigInput.Builder privateKeyJwtConfig(Consumer<PrivateKeyJwtConfig.Builder> privateKeyJwtConfig)

      The private_key_jwt client authentication configuration for this credential provider. When specified, the credential provider uses JWT client assertions to authenticate with the token endpoint.

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

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

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

      CustomOauth2ProviderConfigInput.Builder privateEndpoint(PrivateEndpoint privateEndpoint)

      The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

      Parameters:
      privateEndpoint - The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privateEndpoint

      default CustomOauth2ProviderConfigInput.Builder privateEndpoint(Consumer<PrivateEndpoint.Builder> privateEndpoint)

      The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

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

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

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

      CustomOauth2ProviderConfigInput.Builder privateEndpointOverrides(Collection<PrivateEndpointOverride> privateEndpointOverrides)

      The private endpoint overrides for the custom OAuth2 provider configuration.

      Parameters:
      privateEndpointOverrides - The private endpoint overrides for the custom OAuth2 provider configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privateEndpointOverrides

      CustomOauth2ProviderConfigInput.Builder privateEndpointOverrides(PrivateEndpointOverride... privateEndpointOverrides)

      The private endpoint overrides for the custom OAuth2 provider configuration.

      Parameters:
      privateEndpointOverrides - The private endpoint overrides for the custom OAuth2 provider configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privateEndpointOverrides

      CustomOauth2ProviderConfigInput.Builder privateEndpointOverrides(Consumer<PrivateEndpointOverride.Builder>... privateEndpointOverrides)

      The private endpoint overrides for the custom OAuth2 provider configuration.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to privateEndpointOverrides(List<PrivateEndpointOverride>).

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

      CustomOauth2ProviderConfigInput.Builder certificateConfigurations(Collection<CertificateConfiguration> certificateConfigurations)

      The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can use this only together with privateEndpoint.

      Parameters:
      certificateConfigurations - The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can use this only together with privateEndpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • certificateConfigurations

      CustomOauth2ProviderConfigInput.Builder certificateConfigurations(CertificateConfiguration... certificateConfigurations)

      The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can use this only together with privateEndpoint.

      Parameters:
      certificateConfigurations - The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can use this only together with privateEndpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • certificateConfigurations

      CustomOauth2ProviderConfigInput.Builder certificateConfigurations(Consumer<CertificateConfiguration.Builder>... certificateConfigurations)

      The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can use this only together with privateEndpoint.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificateConfigurations(List<CertificateConfiguration>).

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