Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cognito
  5. IdentityPoolProviderPrincipalTag
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.cognito.IdentityPoolProviderPrincipalTag

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an AWS Cognito Identity Principal Mapping.

    Create IdentityPoolProviderPrincipalTag Resource

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

    Constructor syntax

    new IdentityPoolProviderPrincipalTag(name: string, args: IdentityPoolProviderPrincipalTagArgs, opts?: CustomResourceOptions);
    @overload
def IdentityPoolProviderPrincipalTag(resource_name: str,
                                     args: IdentityPoolProviderPrincipalTagArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def IdentityPoolProviderPrincipalTag(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     identity_pool_id: Optional[str] = None,
                                     identity_provider_name: Optional[str] = None,
                                     principal_tags: Optional[Mapping[str, str]] = None,
                                     use_defaults: Optional[bool] = None)
    func NewIdentityPoolProviderPrincipalTag(ctx *Context, name string, args IdentityPoolProviderPrincipalTagArgs, opts ...ResourceOption) (*IdentityPoolProviderPrincipalTag, error)
    public IdentityPoolProviderPrincipalTag(string name, IdentityPoolProviderPrincipalTagArgs args, CustomResourceOptions? opts = null)
    public IdentityPoolProviderPrincipalTag(String name, IdentityPoolProviderPrincipalTagArgs args)
public IdentityPoolProviderPrincipalTag(String name, IdentityPoolProviderPrincipalTagArgs args, CustomResourceOptions options)

    type: aws:cognito:IdentityPoolProviderPrincipalTag
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 IdentityPoolProviderPrincipalTagArgs
    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 IdentityPoolProviderPrincipalTagArgs
    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 IdentityPoolProviderPrincipalTagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityPoolProviderPrincipalTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityPoolProviderPrincipalTagArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var identityPoolProviderPrincipalTagResource = new Aws.Cognito.IdentityPoolProviderPrincipalTag("identityPoolProviderPrincipalTagResource", new()
{
    IdentityPoolId = "string",
    IdentityProviderName = "string",
    PrincipalTags = 
    {
        { "string", "string" },
    },
    UseDefaults = false,
});

    example, err := cognito.NewIdentityPoolProviderPrincipalTag(ctx, "identityPoolProviderPrincipalTagResource", &cognito.IdentityPoolProviderPrincipalTagArgs{
	IdentityPoolId:       pulumi.String("string"),
	IdentityProviderName: pulumi.String("string"),
	PrincipalTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UseDefaults: pulumi.Bool(false),
})

    var identityPoolProviderPrincipalTagResource = new IdentityPoolProviderPrincipalTag("identityPoolProviderPrincipalTagResource", IdentityPoolProviderPrincipalTagArgs.builder()
    .identityPoolId("string")
    .identityProviderName("string")
    .principalTags(Map.of("string", "string"))
    .useDefaults(false)
    .build());

    identity_pool_provider_principal_tag_resource = aws.cognito.IdentityPoolProviderPrincipalTag("identityPoolProviderPrincipalTagResource",
    identity_pool_id="string",
    identity_provider_name="string",
    principal_tags={
        "string": "string",
    },
    use_defaults=False)

    const identityPoolProviderPrincipalTagResource = new aws.cognito.IdentityPoolProviderPrincipalTag("identityPoolProviderPrincipalTagResource", {
    identityPoolId: "string",
    identityProviderName: "string",
    principalTags: {
        string: "string",
    },
    useDefaults: false,
});

    type: aws:cognito:IdentityPoolProviderPrincipalTag
properties:
    identityPoolId: string
    identityProviderName: string
    principalTags:
        string: string
    useDefaults: false

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

    IdentityPoolId string
    An identity pool ID.
    IdentityProviderName string
    The name of the identity provider.
    PrincipalTags Dictionary<string, string>
    String to string map of variables.
    UseDefaults bool
    use default (username and clientID) attribute mappings.
    IdentityPoolId string
    An identity pool ID.
    IdentityProviderName string
    The name of the identity provider.
    PrincipalTags map[string]string
    String to string map of variables.
    UseDefaults bool
    use default (username and clientID) attribute mappings.
    identityPoolId String
    An identity pool ID.
    identityProviderName String
    The name of the identity provider.
    principalTags Map<String,String>
    String to string map of variables.
    useDefaults Boolean
    use default (username and clientID) attribute mappings.
    identityPoolId string
    An identity pool ID.
    identityProviderName string
    The name of the identity provider.
    principalTags {[key: string]: string}
    String to string map of variables.
    useDefaults boolean
    use default (username and clientID) attribute mappings.
    identity_pool_id str
    An identity pool ID.
    identity_provider_name str
    The name of the identity provider.
    principal_tags Mapping[str, str]
    String to string map of variables.
    use_defaults bool
    use default (username and clientID) attribute mappings.
    identityPoolId String
    An identity pool ID.
    identityProviderName String
    The name of the identity provider.
    principalTags Map<String>
    String to string map of variables.
    useDefaults Boolean
    use default (username and clientID) attribute mappings.

    Outputs

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

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

    Look up Existing IdentityPoolProviderPrincipalTag Resource

    Get an existing IdentityPoolProviderPrincipalTag resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IdentityPoolProviderPrincipalTagState, opts?: CustomResourceOptions): IdentityPoolProviderPrincipalTag
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        identity_pool_id: Optional[str] = None,
        identity_provider_name: Optional[str] = None,
        principal_tags: Optional[Mapping[str, str]] = None,
        use_defaults: Optional[bool] = None) -> IdentityPoolProviderPrincipalTag
    func GetIdentityPoolProviderPrincipalTag(ctx *Context, name string, id IDInput, state *IdentityPoolProviderPrincipalTagState, opts ...ResourceOption) (*IdentityPoolProviderPrincipalTag, error)
    public static IdentityPoolProviderPrincipalTag Get(string name, Input<string> id, IdentityPoolProviderPrincipalTagState? state, CustomResourceOptions? opts = null)
    public static IdentityPoolProviderPrincipalTag get(String name, Output<String> id, IdentityPoolProviderPrincipalTagState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    IdentityPoolId string
    An identity pool ID.
    IdentityProviderName string
    The name of the identity provider.
    PrincipalTags Dictionary<string, string>
    String to string map of variables.
    UseDefaults bool
    use default (username and clientID) attribute mappings.
    IdentityPoolId string
    An identity pool ID.
    IdentityProviderName string
    The name of the identity provider.
    PrincipalTags map[string]string
    String to string map of variables.
    UseDefaults bool
    use default (username and clientID) attribute mappings.
    identityPoolId String
    An identity pool ID.
    identityProviderName String
    The name of the identity provider.
    principalTags Map<String,String>
    String to string map of variables.
    useDefaults Boolean
    use default (username and clientID) attribute mappings.
    identityPoolId string
    An identity pool ID.
    identityProviderName string
    The name of the identity provider.
    principalTags {[key: string]: string}
    String to string map of variables.
    useDefaults boolean
    use default (username and clientID) attribute mappings.
    identity_pool_id str
    An identity pool ID.
    identity_provider_name str
    The name of the identity provider.
    principal_tags Mapping[str, str]
    String to string map of variables.
    use_defaults bool
    use default (username and clientID) attribute mappings.
    identityPoolId String
    An identity pool ID.
    identityProviderName String
    The name of the identity provider.
    principalTags Map<String>
    String to string map of variables.
    useDefaults Boolean
    use default (username and clientID) attribute mappings.

    Import

    Using pulumi import, import Cognito Identity Pool Roles Attachment using the Identity Pool ID and provider name. For example:

    $ pulumi import aws:cognito/identityPoolProviderPrincipalTag:IdentityPoolProviderPrincipalTag example us-west-2_abc123:CorpAD

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws