/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CognitoIdp::CreateIdentityProvider

NAME

Paws::CognitoIdp::CreateIdentityProvider - Arguments for method CreateIdentityProvider on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method CreateIdentityProvider on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method CreateIdentityProvider.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIdentityProvider.

SYNOPSIS

my $cognito-idp = Paws->service('CognitoIdp');
my $CreateIdentityProviderResponse = $cognito -idp->CreateIdentityProvider(
  ProviderDetails  => { 'MyStringType' => 'MyStringType', },
  ProviderName     => 'MyProviderNameTypeV1',
  ProviderType     => 'SAML',
  UserPoolId       => 'MyUserPoolIdType',
  AttributeMapping => {
    'MyAttributeMappingKeyType' => 'MyStringType',    # key: min: 1, max: 32
  },    # OPTIONAL
  IdpIdentifiers => [
    'MyIdpIdentifierType', ...    # min: 1, max: 40
  ],    # OPTIONAL
);

# Results:
my $IdentityProvider = $CreateIdentityProviderResponse->IdentityProvider;

# Returns a L<Paws::CognitoIdp::CreateIdentityProviderResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/CreateIdentityProvider

ATTRIBUTES

AttributeMapping => Paws::CognitoIdp::AttributeMappingType

A mapping of identity provider attributes to standard and custom user pool attributes.

IdpIdentifiers => ArrayRef[Str|Undef]

A list of identity provider identifiers.

REQUIRED ProviderDetails => Paws::CognitoIdp::ProviderDetailsType

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 optional

REQUIRED ProviderName => Str

The identity provider name.

REQUIRED ProviderType => Str

The identity provider type.

Valid values are: "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"

REQUIRED UserPoolId => Str

The user pool ID.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateIdentityProvider in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues