Package software.amazon.awscdk.services.cognito

Class CfnIdentityPoolPrincipalTag

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cognito.CfnIdentityPoolPrincipalTag
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.853Z") @Stability(Stable) public class CfnIdentityPoolPrincipalTag extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::IdentityPoolPrincipalTag.

A list of the identity pool principal tag assignments for attributes for access control.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object principalTags;
 CfnIdentityPoolPrincipalTag cfnIdentityPoolPrincipalTag = CfnIdentityPoolPrincipalTag.Builder.create(this, "MyCfnIdentityPoolPrincipalTag")
         .identityPoolId("identityPoolId")
         .identityProviderName("identityProviderName")
         // the properties below are optional
         .principalTags(principalTags)
         .useDefaults(false)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIdentityPoolPrincipalTag

      protected CfnIdentityPoolPrincipalTag(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIdentityPoolPrincipalTag

      protected CfnIdentityPoolPrincipalTag(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIdentityPoolPrincipalTag

      @Stability(Stable) public CfnIdentityPoolPrincipalTag(@NotNull Construct scope, @NotNull String id, @NotNull CfnIdentityPoolPrincipalTagProps props)
      Create a new AWS::Cognito::IdentityPoolPrincipalTag.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIdentityPoolId

      @Stability(Stable) @NotNull public String getIdentityPoolId()
      The identity pool that you want to associate with this principal tag map.

    • setIdentityPoolId

      @Stability(Stable) public void setIdentityPoolId(@NotNull String value)
      The identity pool that you want to associate with this principal tag map.

    • getIdentityProviderName

      @Stability(Stable) @NotNull public String getIdentityProviderName()
      The identity pool identity provider (IdP) that you want to associate with this principal tag map.

    • setIdentityProviderName

      @Stability(Stable) public void setIdentityProviderName(@NotNull String value)
      The identity pool identity provider (IdP) that you want to associate with this principal tag map.

    • getPrincipalTags

      @Stability(Stable) @NotNull public Object getPrincipalTags()
      A JSON-formatted list of user claims and the principal tags that you want to associate with them.

      When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.

    • setPrincipalTags

      @Stability(Stable) public void setPrincipalTags(@NotNull Object value)
      A JSON-formatted list of user claims and the principal tags that you want to associate with them.

      When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.

    • getUseDefaults

      @Stability(Stable) @Nullable public Object getUseDefaults()
      Use a default set of mappings between claims and tags for this provider, instead of a custom map.

    • setUseDefaults

      @Stability(Stable) public void setUseDefaults(@Nullable Boolean value)
      Use a default set of mappings between claims and tags for this provider, instead of a custom map.

    • setUseDefaults

      @Stability(Stable) public void setUseDefaults(@Nullable IResolvable value)
      Use a default set of mappings between claims and tags for this provider, instead of a custom map.