Package software.amazon.awssdk.services.workspacesweb.model

Interface UpdateIdentityProviderRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateIdentityProviderRequest.Builder,UpdateIdentityProviderRequest>, SdkBuilder<UpdateIdentityProviderRequest.Builder,UpdateIdentityProviderRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesWebRequest.Builder
Enclosing class:
UpdateIdentityProviderRequest
public static interface UpdateIdentityProviderRequest.Builder extends WorkSpacesWebRequest.Builder, SdkPojo, CopyableBuilder<UpdateIdentityProviderRequest.Builder,UpdateIdentityProviderRequest>

  • Method Details

    • clientToken

      UpdateIdentityProviderRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderArn

      UpdateIdentityProviderRequest.Builder identityProviderArn(String identityProviderArn)

      The ARN of the identity provider.

      Parameters:
      identityProviderArn - The ARN of the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderDetails

      UpdateIdentityProviderRequest.Builder identityProviderDetails(Map<String,String> identityProviderDetails)

      The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

      • For Google and Login with Amazon:

        • client_id

        • client_secret

        • authorize_scopes

      • For Facebook:

        • client_id

        • client_secret

        • authorize_scopes

        • api_version

      • For Sign in with Apple:

        • client_id

        • team_id

        • key_id

        • private_key

        • authorize_scopes

      • For OIDC providers:

        • client_id

        • client_secret

        • attributes_request_method

        • oidc_issuer

        • authorize_scopes

        • authorize_url if not available from discovery URL specified by oidc_issuer key

        • token_url if not available from discovery URL specified by oidc_issuer key

        • attributes_url if not available from discovery URL specified by oidc_issuer key

        • jwks_uri if not available from discovery URL specified by oidc_issuer key

      • For SAML providers:

        • MetadataFile OR MetadataURL

        • IDPSignout (boolean) optional

        • IDPInit (boolean) optional

        • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

        • EncryptedResponses (boolean) optional

      Parameters:
      identityProviderDetails - The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

      • For Google and Login with Amazon:

        • client_id

        • client_secret

        • authorize_scopes

      • For Facebook:

        • client_id

        • client_secret

        • authorize_scopes

        • api_version

      • For Sign in with Apple:

        • client_id

        • team_id

        • key_id

        • private_key

        • authorize_scopes

      • For OIDC providers:

        • client_id

        • client_secret

        • attributes_request_method

        • oidc_issuer

        • authorize_scopes

        • authorize_url if not available from discovery URL specified by oidc_issuer key

        • token_url if not available from discovery URL specified by oidc_issuer key

        • attributes_url if not available from discovery URL specified by oidc_issuer key

        • jwks_uri if not available from discovery URL specified by oidc_issuer key

      • For SAML providers:

        • MetadataFile OR MetadataURL

        • IDPSignout (boolean) optional

        • IDPInit (boolean) optional

        • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

        • EncryptedResponses (boolean) optional

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderName

      UpdateIdentityProviderRequest.Builder identityProviderName(String identityProviderName)

      The name of the identity provider.

      Parameters:
      identityProviderName - The name of the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderType

      UpdateIdentityProviderRequest.Builder identityProviderType(String identityProviderType)

      The type of the identity provider.

      Parameters:
      identityProviderType - The type of the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • identityProviderType

      UpdateIdentityProviderRequest.Builder identityProviderType(IdentityProviderType identityProviderType)

      The type of the identity provider.

      Parameters:
      identityProviderType - The type of the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateIdentityProviderRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateIdentityProviderRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.