Package software.amazon.awscdk.services.cognito

Interface CfnIdentityPoolRoleAttachment.MappingRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityPoolRoleAttachment.MappingRuleProperty.Jsii$Proxy

Enclosing class:

CfnIdentityPoolRoleAttachment

@Stability(Stable)
public static interface CfnIdentityPoolRoleAttachment.MappingRuleProperty
extends software.amazon.jsii.JsiiSerializable

Defines how to map a claim to a role ARN.

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.*;
 MappingRuleProperty mappingRuleProperty = MappingRuleProperty.builder()
         .claim("claim")
         .matchType("matchType")
         .roleArn("roleArn")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdentityPoolRoleAttachment.MappingRuleProperty.Builder	A builder for CfnIdentityPoolRoleAttachment.MappingRuleProperty
static final class	CfnIdentityPoolRoleAttachment.MappingRuleProperty.Jsii$Proxy	An implementation for CfnIdentityPoolRoleAttachment.MappingRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnIdentityPoolRoleAttachment.MappingRuleProperty.Builder	builder()
String	getClaim()	The claim name that must be present in the token.
String	getMatchType()	The match condition that specifies how closely the claim value in the IdP token must match Value .
String	getRoleArn()	The Amazon Resource Name (ARN) of the role.
String	getValue()	A brief string that the claim must match.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClaim

@Stability(Stable)
@NotNull
String getClaim()

The claim name that must be present in the token.

For example: "isAdmin" or "paid".

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim

getMatchType

@Stability(Stable)
@NotNull
String getMatchType()

The match condition that specifies how closely the claim value in the IdP token must match Value .

Valid values are: Equals , Contains , StartsWith , and NotEqual .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn

getValue

@Stability(Stable)
@NotNull
String getValue()

A brief string that the claim must match.

For example, "paid" or "yes".

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value

builder

@Stability(Stable)
static CfnIdentityPoolRoleAttachment.MappingRuleProperty.Builder builder()

Returns:

a CfnIdentityPoolRoleAttachment.MappingRuleProperty.Builder of CfnIdentityPoolRoleAttachment.MappingRuleProperty