Package software.amazon.awssdk.services.cognitoidentity.model

Interface GetCredentialsForIdentityRequest.Builder

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

  • Method Details

    • identityId

      GetCredentialsForIdentityRequest.Builder identityId(String identityId)

      A unique identifier in the format REGION:GUID.

      Parameters:
      identityId - A unique identifier in the format REGION:GUID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logins

      GetCredentialsForIdentityRequest.Builder logins(Map<String,String> logins)

      A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

      Logins should not be specified when trying to get credentials for an unauthenticated identity.

      The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

      Parameters:
      logins - A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

      Logins should not be specified when trying to get credentials for an unauthenticated identity.

      The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

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

    • customRoleArn

      GetCredentialsForIdentityRequest.Builder customRoleArn(String customRoleArn)

      The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

      Parameters:
      customRoleArn - The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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