Class CreateIdentityProviderRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.workspacesweb.model.WorkSpacesWebRequest
software.amazon.awssdk.services.workspacesweb.model.CreateIdentityProviderRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateIdentityProviderRequest extends WorkSpacesWebRequest implements ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>

  • Method Details

    • clientToken

      public final 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.

      Returns:
      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.

    • hasIdentityProviderDetails

      public final boolean hasIdentityProviderDetails()
      For responses, this returns true if the service returned a value for the IdentityProviderDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • identityProviderDetails

      public final 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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIdentityProviderDetails() method.

      Returns:
      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

    • identityProviderName

      public final String identityProviderName()

      The identity provider name.

      Returns:
      The identity provider name.

    • identityProviderType

      public final IdentityProviderType identityProviderType()

      The identity provider type.

      If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

      Returns:
      The identity provider type.
      See Also:

    • identityProviderTypeAsString

      public final String identityProviderTypeAsString()

      The identity provider type.

      If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

      Returns:
      The identity provider type.
      See Also:

    • portalArn

      public final String portalArn()

      The ARN of the web portal.

      Returns:
      The ARN of the web portal.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • toBuilder

      public CreateIdentityProviderRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>
      Specified by:
      toBuilder in class WorkSpacesWebRequest
      Returns:
      a builder for type T

    • builder

      public static CreateIdentityProviderRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateIdentityProviderRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.