1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. UserPoolIdentityProvider

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.cognito.UserPoolIdentityProvider

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource Type definition for AWS::Cognito::UserPoolIdentityProvider

    Create UserPoolIdentityProvider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserPoolIdentityProvider(name: string, args: UserPoolIdentityProviderArgs, opts?: CustomResourceOptions);
    @overload
    def UserPoolIdentityProvider(resource_name: str,
                                 args: UserPoolIdentityProviderArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserPoolIdentityProvider(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 provider_type: Optional[str] = None,
                                 user_pool_id: Optional[str] = None,
                                 attribute_mapping: Optional[Any] = None,
                                 idp_identifiers: Optional[Sequence[str]] = None,
                                 provider_details: Optional[Any] = None,
                                 provider_name: Optional[str] = None)
    func NewUserPoolIdentityProvider(ctx *Context, name string, args UserPoolIdentityProviderArgs, opts ...ResourceOption) (*UserPoolIdentityProvider, error)
    public UserPoolIdentityProvider(string name, UserPoolIdentityProviderArgs args, CustomResourceOptions? opts = null)
    public UserPoolIdentityProvider(String name, UserPoolIdentityProviderArgs args)
    public UserPoolIdentityProvider(String name, UserPoolIdentityProviderArgs args, CustomResourceOptions options)
    
    type: aws-native:cognito:UserPoolIdentityProvider
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args UserPoolIdentityProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserPoolIdentityProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserPoolIdentityProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolIdentityProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolIdentityProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const userPoolIdentityProviderResource = new aws_native.cognito.UserPoolIdentityProvider("userPoolIdentityProviderResource", {
        providerType: "string",
        userPoolId: "string",
        attributeMapping: "any",
        idpIdentifiers: ["string"],
        providerDetails: "any",
        providerName: "string",
    });
    
    Coming soon!
    

    UserPoolIdentityProvider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The UserPoolIdentityProvider resource accepts the following input properties:

    ProviderType string
    UserPoolId string
    AttributeMapping object
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    IdpIdentifiers List<string>
    ProviderDetails object
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    ProviderName string
    ProviderType string
    UserPoolId string
    AttributeMapping interface{}
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    IdpIdentifiers []string
    ProviderDetails interface{}
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    ProviderName string
    providerType String
    userPoolId String
    attributeMapping Object
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    idpIdentifiers List<String>
    providerDetails Object
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    providerName String
    providerType string
    userPoolId string
    attributeMapping any
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    idpIdentifiers string[]
    providerDetails any
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    providerName string
    provider_type str
    user_pool_id str
    attribute_mapping Any
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    idp_identifiers Sequence[str]
    provider_details Any
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    provider_name str
    providerType String
    userPoolId String
    attributeMapping Any
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    idpIdentifiers List<String>
    providerDetails Any
    Search the CloudFormation User Guide for AWS::Cognito::UserPoolIdentityProvider for more information about the expected schema for this property.
    providerName String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPoolIdentityProvider resource produces the following output properties:

    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi