Class CfnIdentityPoolPrincipalTag
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnIdentityPoolPrincipalTag
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:40.758Z")
@Stability(Stable)
public class CfnIdentityPoolPrincipalTag
extends CfnResource
implements IInspectable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnIdentityPoolPrincipalTag
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnIdentityPoolPrincipalTag
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnIdentityPoolPrincipalTag
(software.amazon.jsii.JsiiObjectRef objRef) CfnIdentityPoolPrincipalTag
(software.constructs.Construct scope, String id, CfnIdentityPoolPrincipalTagProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe identity pool that you want to associate with this principal tag map.The identity pool identity provider (IdP) that you want to associate with this principal tag map.A JSON-formatted list of user claims and the principal tags that you want to associate with them.Use a default set of mappings between claims and tags for this provider, instead of a custom map.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setIdentityPoolId
(String value) The identity pool that you want to associate with this principal tag map.void
setIdentityProviderName
(String value) The identity pool identity provider (IdP) that you want to associate with this principal tag map.void
setPrincipalTags
(Object value) A JSON-formatted list of user claims and the principal tags that you want to associate with them.void
setUseDefaults
(Boolean value) Use a default set of mappings between claims and tags for this provider, instead of a custom map.void
setUseDefaults
(IResolvable value) Use a default set of mappings between claims and tags for this provider, instead of a custom map.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdentityPoolPrincipalTagProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getIdentityPoolId
The identity pool that you want to associate with this principal tag map. -
setIdentityPoolId
The identity pool that you want to associate with this principal tag map. -
getIdentityProviderName
The identity pool identity provider (IdP) that you want to associate with this principal tag map. -
setIdentityProviderName
The identity pool identity provider (IdP) that you want to associate with this principal tag map. -
getPrincipalTags
A JSON-formatted list of user claims and the principal tags that you want to associate with them. -
setPrincipalTags
A JSON-formatted list of user claims and the principal tags that you want to associate with them. -
getUseDefaults
Use a default set of mappings between claims and tags for this provider, instead of a custom map. -
setUseDefaults
Use a default set of mappings between claims and tags for this provider, instead of a custom map. -
setUseDefaults
Use a default set of mappings between claims and tags for this provider, instead of a custom map.
-