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

Interface CreateIdentityProviderRequest.Builder

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

  • Method Details

    • clientToken

      CreateIdentityProviderRequest.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 returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS 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 returns the result from the original successful request.

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

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

    • identityProviderDetails

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

      The identity provider details. 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

      Parameters:
      identityProviderDetails - The identity provider details. 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

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

    • identityProviderName

      CreateIdentityProviderRequest.Builder identityProviderName(String identityProviderName)

      The identity provider name.

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

    • identityProviderType

      CreateIdentityProviderRequest.Builder identityProviderType(String identityProviderType)

      The identity provider type.

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

    • identityProviderType

      CreateIdentityProviderRequest.Builder identityProviderType(IdentityProviderType identityProviderType)

      The identity provider type.

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

    • portalArn

      CreateIdentityProviderRequest.Builder portalArn(String portalArn)

      The ARN of the web portal.

      Parameters:
      portalArn - The ARN of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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