@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
80 lines (79 loc) • 4.03 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
*/
export declare class IdentityPoolRoleAttachment extends pulumi.CustomResource {
/**
* Get an existing IdentityPoolRoleAttachment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): IdentityPoolRoleAttachment;
/**
* Returns true if the given object is an instance of IdentityPoolRoleAttachment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is IdentityPoolRoleAttachment;
/**
* The resource ID.
*/
readonly awsId: pulumi.Output<string>;
/**
* An identity pool ID in the format `REGION:GUID` .
*/
readonly identityPoolId: pulumi.Output<string>;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html) .
*/
readonly roleMappings: pulumi.Output<{
[key: string]: outputs.cognito.IdentityPoolRoleAttachmentRoleMapping;
} | undefined>;
/**
* 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.
*/
readonly roles: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Create a IdentityPoolRoleAttachment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: IdentityPoolRoleAttachmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a IdentityPoolRoleAttachment resource.
*/
export interface IdentityPoolRoleAttachmentArgs {
/**
* An identity pool ID in the format `REGION:GUID` .
*/
identityPoolId: pulumi.Input<string>;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html) .
*/
roleMappings?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.cognito.IdentityPoolRoleAttachmentRoleMappingArgs>;
}>;
/**
* 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.
*/
roles?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}