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

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

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

    Create IdentityPoolRoleAttachment Resource

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

    Constructor syntax

    new IdentityPoolRoleAttachment(name: string, args: IdentityPoolRoleAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def IdentityPoolRoleAttachment(resource_name: str,
                                   args: IdentityPoolRoleAttachmentArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdentityPoolRoleAttachment(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   identity_pool_id: Optional[str] = None,
                                   role_mappings: Optional[Mapping[str, IdentityPoolRoleAttachmentRoleMappingArgs]] = None,
                                   roles: Optional[Mapping[str, str]] = None)
    func NewIdentityPoolRoleAttachment(ctx *Context, name string, args IdentityPoolRoleAttachmentArgs, opts ...ResourceOption) (*IdentityPoolRoleAttachment, error)
    public IdentityPoolRoleAttachment(string name, IdentityPoolRoleAttachmentArgs args, CustomResourceOptions? opts = null)
    public IdentityPoolRoleAttachment(String name, IdentityPoolRoleAttachmentArgs args)
    public IdentityPoolRoleAttachment(String name, IdentityPoolRoleAttachmentArgs args, CustomResourceOptions options)
    
    type: aws-native:cognito:IdentityPoolRoleAttachment
    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 IdentityPoolRoleAttachmentArgs
    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 IdentityPoolRoleAttachmentArgs
    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 IdentityPoolRoleAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityPoolRoleAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityPoolRoleAttachmentArgs
    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 identityPoolRoleAttachmentResource = new aws_native.cognito.IdentityPoolRoleAttachment("identityPoolRoleAttachmentResource", {
        identityPoolId: "string",
        roleMappings: {
            string: {
                type: "string",
                ambiguousRoleResolution: "string",
                identityProvider: "string",
                rulesConfiguration: {
                    rules: [{
                        claim: "string",
                        matchType: "string",
                        roleArn: "string",
                        value: "string",
                    }],
                },
            },
        },
        roles: {
            string: "string",
        },
    });
    
    Coming soon!
    

    IdentityPoolRoleAttachment 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 IdentityPoolRoleAttachment resource accepts the following input properties:

    IdentityPoolId string
    RoleMappings Dictionary<string, Pulumi.AwsNative.Cognito.Inputs.IdentityPoolRoleAttachmentRoleMappingArgs>
    Roles Dictionary<string, string>
    IdentityPoolId string
    RoleMappings map[string]IdentityPoolRoleAttachmentRoleMappingArgs
    Roles map[string]string
    identityPoolId String
    roleMappings Map<String,IdentityPoolRoleAttachmentRoleMappingArgs>
    roles Map<String,String>
    identityPoolId string
    roleMappings {[key: string]: IdentityPoolRoleAttachmentRoleMappingArgs}
    roles {[key: string]: string}
    identity_pool_id str
    role_mappings Mapping[str, IdentityPoolRoleAttachmentRoleMappingArgs]
    roles Mapping[str, str]
    identityPoolId String
    roleMappings Map<Property Map>
    roles Map<String>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdentityPoolRoleAttachment 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.

    Supporting Types

    IdentityPoolRoleAttachmentMappingRule, IdentityPoolRoleAttachmentMappingRuleArgs

    Claim string
    MatchType string
    RoleArn string
    Value string
    Claim string
    MatchType string
    RoleArn string
    Value string
    claim String
    matchType String
    roleArn String
    value String
    claim string
    matchType string
    roleArn string
    value string
    claim String
    matchType String
    roleArn String
    value String

    IdentityPoolRoleAttachmentRoleMapping, IdentityPoolRoleAttachmentRoleMappingArgs

    IdentityPoolRoleAttachmentRulesConfigurationType, IdentityPoolRoleAttachmentRulesConfigurationTypeArgs

    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