AWS Native v0.108.3, Jun 12 24

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cognito.IdentityPoolRoleAttachment

Explore with Pulumi AI

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

pulumi/pulumi-aws-native

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

An identity pool ID in the format REGION:GUID .

RoleMappings Dictionary<string, Pulumi.AwsNative.Cognito.Inputs.IdentityPoolRoleAttachmentRoleMappingArgs>

How users for a specific identity provider are mapped to roles. This is a string to the RoleMapping object map. The string identifies the identity provider. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id .

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

Roles Dictionary<string, string>

The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

IdentityPoolId string

An identity pool ID in the format REGION:GUID .

RoleMappings map[string]IdentityPoolRoleAttachmentRoleMappingArgs

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

Roles map[string]string

The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

identityPoolId String

An identity pool ID in the format REGION:GUID .

roleMappings Map<String,IdentityPoolRoleAttachmentRoleMappingArgs>

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

roles Map<String,String>

The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

identityPoolId string

An identity pool ID in the format REGION:GUID .

roleMappings {[key: string]: IdentityPoolRoleAttachmentRoleMappingArgs}

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

roles {[key: string]: string}

The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

identity_pool_id str

An identity pool ID in the format REGION:GUID .

role_mappings Mapping[str, IdentityPoolRoleAttachmentRoleMappingArgs]

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

roles Mapping[str, str]

The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

identityPoolId String

An identity pool ID in the format REGION:GUID .

roleMappings Map<Property Map>

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

roles Map<String>

The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

Outputs

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

AwsId string: The resource ID.
Id string: The provider-assigned unique ID for this managed resource.