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

Interface CreateIdentityProviderRequest.Builder

    • Method Detail

      • 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 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 returns 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.

      • 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

          • IDPInit (boolean) optional

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

          • EncryptedResponses (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

          • 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

        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.

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

      • tags

        CreateIdentityProviderRequest.Builder tags​(Collection<Tag> tags)

        The tags to add to the identity provider resource. A tag is a key-value pair.

        Parameters:
        tags - The tags to add to the identity provider resource. A tag is a key-value pair.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateIdentityProviderRequest.Builder tags​(Tag... tags)

        The tags to add to the identity provider resource. A tag is a key-value pair.

        Parameters:
        tags - The tags to add to the identity provider resource. A tag is a key-value pair.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateIdentityProviderRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags to add to the identity provider resource. A tag is a key-value pair.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)