AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

MappingRule

import "github.com/aws/aws-sdk-go/service/cognitoidentity"

type MappingRule struct { Claim *string `min:"1" type:"string" required:"true"` MatchType *string `type:"string" required:"true" enum:"MappingRuleMatchType"` RoleARN *string `min:"20" type:"string" required:"true"` Value *string `min:"1" type:"string" required:"true"` }

A rule that maps a claim name, a claim value, and a match type to a role ARN.

Claim

Type: *string

The claim name that must be present in the token, for example, "isAdmin" or "paid".

Claim is a required field

MatchType

Type: *string

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

MatchType is a required field

RoleARN

Type: *string

The role ARN.

RoleARN is a required field

Value

Type: *string

A brief string that the claim must match, for example, "paid" or "yes".

Value is a required field

Method

GoString

func (s MappingRule) GoString() string

GoString returns the string representation

SetClaim

func (s *MappingRule) SetClaim(v string) *MappingRule

SetClaim sets the Claim field's value.

SetMatchType

func (s *MappingRule) SetMatchType(v string) *MappingRule

SetMatchType sets the MatchType field's value.

SetRoleARN

func (s *MappingRule) SetRoleARN(v string) *MappingRule

SetRoleARN sets the RoleARN field's value.

SetValue

func (s *MappingRule) SetValue(v string) *MappingRule

SetValue sets the Value field's value.

String

func (s MappingRule) String() string

String returns the string representation

Validate

func (s *MappingRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: