Package com.pulumi.aws.cognito

Class IdentityPoolProviderPrincipalTag

  • public class IdentityPoolProviderPrincipalTag
extends com.pulumi.resources.CustomResource
    Provides an AWS Cognito Identity Principal Mapping. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.UserPool;
 import com.pulumi.aws.cognito.UserPoolArgs;
 import com.pulumi.aws.cognito.UserPoolClient;
 import com.pulumi.aws.cognito.UserPoolClientArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.CompactArgs;
 import com.pulumi.aws.cognito.IdentityPool;
 import com.pulumi.aws.cognito.IdentityPoolArgs;
 import com.pulumi.aws.cognito.inputs.IdentityPoolCognitoIdentityProviderArgs;
 import com.pulumi.aws.cognito.IdentityPoolProviderPrincipalTag;
 import com.pulumi.aws.cognito.IdentityPoolProviderPrincipalTagArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new UserPool("example", UserPoolArgs.builder()
             .name("user pool")
             .autoVerifiedAttributes("email")
             .build());
 
         var exampleUserPoolClient = new UserPoolClient("exampleUserPoolClient", UserPoolClientArgs.builder()
             .name("client")
             .userPoolId(example.id())
             .supportedIdentityProviders(StdFunctions.compact(CompactArgs.builder()
                 .input("COGNITO")
                 .build()).result())
             .build());
 
         var exampleIdentityPool = new IdentityPool("exampleIdentityPool", IdentityPoolArgs.builder()
             .cognitoIdentityProviders(IdentityPoolCognitoIdentityProviderArgs.builder()
                 .clientId(exampleUserPoolClient.id())
                 .providerName(example.endpoint())
                 .serverSideTokenCheck(false)
                 .build())
             .identityPoolName("identity pool")
             .allowUnauthenticatedIdentities(false)
             .build());
 
         var exampleIdentityPoolProviderPrincipalTag = new IdentityPoolProviderPrincipalTag("exampleIdentityPoolProviderPrincipalTag", IdentityPoolProviderPrincipalTagArgs.builder()
             .identityPoolId(exampleIdentityPool.id())
             .identityProviderName(example.endpoint())
             .useDefaults(false)
             .principalTags(Map.of("test", "value"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Cognito Identity Pool Roles Attachment using the Identity Pool ID and provider name. For example: ```sh $ pulumi import aws:cognito/identityPoolProviderPrincipalTag:IdentityPoolProviderPrincipalTag example us-west-2_abc123:CorpAD ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static IdentityPoolProviderPrincipalTag get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IdentityPoolProviderPrincipalTagState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> identityPoolId()  
      com.pulumi.core.Output<java.lang.String> identityProviderName()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> principalTags()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> useDefaults()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IdentityPoolProviderPrincipalTag

        public IdentityPoolProviderPrincipalTag​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IdentityPoolProviderPrincipalTag

        public IdentityPoolProviderPrincipalTag​(java.lang.String name,
                                        IdentityPoolProviderPrincipalTagArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IdentityPoolProviderPrincipalTag

        public IdentityPoolProviderPrincipalTag​(java.lang.String name,
                                        IdentityPoolProviderPrincipalTagArgs args,
                                        @Nullable
                                        com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • identityPoolId

        public com.pulumi.core.Output<java.lang.String> identityPoolId()
        Returns:
        An identity pool ID.

      • identityProviderName

        public com.pulumi.core.Output<java.lang.String> identityProviderName()
        Returns:
        The name of the identity provider.

      • principalTags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> principalTags()
        Returns:
        String to string map of variables.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • useDefaults

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> useDefaults()
        Returns:
        use default (username and clientID) attribute mappings.

      • get

        public static IdentityPoolProviderPrincipalTag get​(java.lang.String name,
                                                   com.pulumi.core.Output<java.lang.String> id,
                                                   @Nullable
                                                   IdentityPoolProviderPrincipalTagState state,
                                                   @Nullable
                                                   com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.