awscognitoidentitypool

package
v1.145.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 19, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IdentityPoolRoleAttachment_IsConstruct 

func IdentityPoolRoleAttachment_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func IdentityPoolRoleAttachment_IsResource 

func IdentityPoolRoleAttachment_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func IdentityPool_IsConstruct 

func IdentityPool_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func IdentityPool_IsResource 

func IdentityPool_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewIdentityPoolProviderUrl_Override 

func NewIdentityPoolProviderUrl_Override(i IdentityPoolProviderUrl, type_ IdentityPoolProviderType, value *string)

Experimental.

func NewIdentityPoolRoleAttachment_Override 

func NewIdentityPoolRoleAttachment_Override(i IdentityPoolRoleAttachment, scope constructs.Construct, id *string, props *IdentityPoolRoleAttachmentProps)

Experimental.

func NewIdentityPool_Override 

func NewIdentityPool_Override(i IdentityPool, scope constructs.Construct, id *string, props *IdentityPoolProps)

Experimental.

func NewUserPoolAuthenticationProvider_Override 

func NewUserPoolAuthenticationProvider_Override(u UserPoolAuthenticationProvider, props *UserPoolAuthenticationProviderProps)

Experimental.

Types

type IIdentityPool 

type IIdentityPool interface {
	awscdk.IResource
	// The ARN of the Identity Pool.
	// Experimental.
	IdentityPoolArn() *string
	// The id of the Identity Pool in the format REGION:GUID.
	// Experimental.
	IdentityPoolId() *string
	// Name of the Identity Pool.
	// Experimental.
	IdentityPoolName() *string
}

Represents a Cognito IdentityPool. Experimental.

func IdentityPool_FromIdentityPoolArn 

func IdentityPool_FromIdentityPoolArn(scope constructs.Construct, id *string, identityPoolArn *string) IIdentityPool

Import an existing Identity Pool from its Arn. Experimental.

func IdentityPool_FromIdentityPoolId 

func IdentityPool_FromIdentityPoolId(scope constructs.Construct, id *string, identityPoolId *string) IIdentityPool

Import an existing Identity Pool from its id. Experimental.

type IIdentityPoolRoleAttachment 

type IIdentityPoolRoleAttachment interface {
	awscdk.IResource
	// Id of the Attachments Underlying Identity Pool.
	// Experimental.
	IdentityPoolId() *string
}

Represents an Identity Pool Role Attachment. Experimental.

type IUserPoolAuthenticationProvider 

type IUserPoolAuthenticationProvider interface {
	// The method called when a given User Pool Authentication Provider is added (for the first time) to an Identity Pool.
	// Experimental.
	Bind(scope constructs.Construct, identityPool IIdentityPool, options *UserPoolAuthenticationProviderBindOptions) *UserPoolAuthenticationProviderBindConfig
}

Represents the concept of a User Pool Authentication Provider.

You use user pool authentication providers to configure User Pools and User Pool Clients for use with Identity Pools Experimental.

type IdentityPool 

type IdentityPool interface {
	awscdk.Resource
	IIdentityPool
	AuthenticatedRole() awsiam.IRole
	Env() *awscdk.ResourceEnvironment
	IdentityPoolArn() *string
	IdentityPoolId() *string
	IdentityPoolName() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	UnauthenticatedRole() awsiam.IRole
	AddRoleMappings(roleMappings ...*IdentityPoolRoleMapping)
	AddUserPoolAuthentication(userPool IUserPoolAuthenticationProvider)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Define a Cognito Identity Pool.

TODO: EXAMPLE

Experimental.

func NewIdentityPool 

func NewIdentityPool(scope constructs.Construct, id *string, props *IdentityPoolProps) IdentityPool

Experimental.

type IdentityPoolAmazonLoginProvider 

type IdentityPoolAmazonLoginProvider struct {
	// App Id for Amazon Identity Federation.
	// Experimental.
	AppId *string `json:"appId" yaml:"appId"`
}

Login Provider for Identity Federation using Amazon Credentials.

TODO: EXAMPLE

Experimental.

type IdentityPoolAppleLoginProvider 

type IdentityPoolAppleLoginProvider struct {
	// App Id for Apple Identity Federation.
	// Experimental.
	ServicesId *string `json:"servicesId" yaml:"servicesId"`
}

Login Provider for Identity Federation using Apple Credentials.

TODO: EXAMPLE

Experimental.

type IdentityPoolAuthenticationProviders 

type IdentityPoolAuthenticationProviders struct {
	// App Id for Amazon Identity Federation.
	// Experimental.
	Amazon *IdentityPoolAmazonLoginProvider `json:"amazon" yaml:"amazon"`
	// Services Id for Apple Identity Federation.
	// Experimental.
	Apple *IdentityPoolAppleLoginProvider `json:"apple" yaml:"apple"`
	// Consumer Key and Secret for Digits Identity Federation.
	// Experimental.
	Digits *IdentityPoolDigitsLoginProvider `json:"digits" yaml:"digits"`
	// App Id for Facebook Identity Federation.
	// Experimental.
	Facebook *IdentityPoolFacebookLoginProvider `json:"facebook" yaml:"facebook"`
	// Client Id for Google Identity Federation.
	// Experimental.
	Google *IdentityPoolGoogleLoginProvider `json:"google" yaml:"google"`
	// Consumer Key and Secret for Twitter Identity Federation.
	// Experimental.
	Twitter *IdentityPoolTwitterLoginProvider `json:"twitter" yaml:"twitter"`
	// The Developer Provider Name to associate with this Identity Pool.
	// Experimental.
	CustomProvider *string `json:"customProvider" yaml:"customProvider"`
	// The OpenIdConnect Provider associated with this Identity Pool.
	// Experimental.
	OpenIdConnectProviders *[]awsiam.IOpenIdConnectProvider `json:"openIdConnectProviders" yaml:"openIdConnectProviders"`
	// The Security Assertion Markup Language Provider associated with this Identity Pool.
	// Experimental.
	SamlProviders *[]awsiam.ISamlProvider `json:"samlProviders" yaml:"samlProviders"`
	// The User Pool Authentication Providers associated with this Identity Pool.
	// Experimental.
	UserPools *[]IUserPoolAuthenticationProvider `json:"userPools" yaml:"userPools"`
}

Authentication providers for using in identity pool.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html

Experimental.

type IdentityPoolDigitsLoginProvider 

type IdentityPoolDigitsLoginProvider struct {
	// App Id for Twitter Identity Federation.
	// Experimental.
	ConsumerKey *string `json:"consumerKey" yaml:"consumerKey"`
	// App Secret for Twitter Identity Federation.
	// Experimental.
	ConsumerSecret *string `json:"consumerSecret" yaml:"consumerSecret"`
}

Login Provider for Identity Federation using Digits Credentials.

TODO: EXAMPLE

Experimental.

type IdentityPoolFacebookLoginProvider 

type IdentityPoolFacebookLoginProvider struct {
	// App Id for Facebook Identity Federation.
	// Experimental.
	AppId *string `json:"appId" yaml:"appId"`
}

Login Provider for Identity Federation using Facebook Credentials.

TODO: EXAMPLE

Experimental.

type IdentityPoolGoogleLoginProvider 

type IdentityPoolGoogleLoginProvider struct {
	// App Id for Google Identity Federation.
	// Experimental.
	ClientId *string `json:"clientId" yaml:"clientId"`
}

Login Provider for Identity Federation using Google Credentials.

TODO: EXAMPLE

Experimental.

type IdentityPoolProps 

type IdentityPoolProps struct {
	// Enables the Basic (Classic) authentication flow.
	// Experimental.
	AllowClassicFlow *bool `json:"allowClassicFlow" yaml:"allowClassicFlow"`
	// Wwhether the identity pool supports unauthenticated logins.
	// Experimental.
	AllowUnauthenticatedIdentities *bool `json:"allowUnauthenticatedIdentities" yaml:"allowUnauthenticatedIdentities"`
	// The Default Role to be assumed by Authenticated Users.
	// Experimental.
	AuthenticatedRole awsiam.IRole `json:"authenticatedRole" yaml:"authenticatedRole"`
	// Authentication providers for using in identity pool.
	// Experimental.
	AuthenticationProviders *IdentityPoolAuthenticationProviders `json:"authenticationProviders" yaml:"authenticationProviders"`
	// The name of the Identity Pool.
	// Experimental.
	IdentityPoolName *string `json:"identityPoolName" yaml:"identityPoolName"`
	// Rules for mapping roles to users.
	// Experimental.
	RoleMappings *[]*IdentityPoolRoleMapping `json:"roleMappings" yaml:"roleMappings"`
	// The Default Role to be assumed by Unauthenticated Users.
	// Experimental.
	UnauthenticatedRole awsiam.IRole `json:"unauthenticatedRole" yaml:"unauthenticatedRole"`
}

Props for the IdentityPool construct.

TODO: EXAMPLE

Experimental.

type IdentityPoolProviderType 

type IdentityPoolProviderType string

Types of Identity Pool Login Providers. Experimental. 

const (
	IdentityPoolProviderType_FACEBOOK  IdentityPoolProviderType = "FACEBOOK"
	IdentityPoolProviderType_GOOGLE    IdentityPoolProviderType = "GOOGLE"
	IdentityPoolProviderType_AMAZON    IdentityPoolProviderType = "AMAZON"
	IdentityPoolProviderType_APPLE     IdentityPoolProviderType = "APPLE"
	IdentityPoolProviderType_TWITTER   IdentityPoolProviderType = "TWITTER"
	IdentityPoolProviderType_DIGITS    IdentityPoolProviderType = "DIGITS"
	IdentityPoolProviderType_OPEN_ID   IdentityPoolProviderType = "OPEN_ID"
	IdentityPoolProviderType_SAML      IdentityPoolProviderType = "SAML"
	IdentityPoolProviderType_USER_POOL IdentityPoolProviderType = "USER_POOL"
	IdentityPoolProviderType_CUSTOM    IdentityPoolProviderType = "CUSTOM"
)

type IdentityPoolProviderUrl 

type IdentityPoolProviderUrl interface {
	Type() IdentityPoolProviderType
	Value() *string
}

Keys for Login Providers - correspond to client id's of respective federation identity providers.

TODO: EXAMPLE

Experimental.

func IdentityPoolProviderUrl_AMAZON 

func IdentityPoolProviderUrl_AMAZON() IdentityPoolProviderUrl

func IdentityPoolProviderUrl_APPLE 

func IdentityPoolProviderUrl_APPLE() IdentityPoolProviderUrl

func IdentityPoolProviderUrl_Custom 

func IdentityPoolProviderUrl_Custom(url *string) IdentityPoolProviderUrl

Custom Provider Url. Experimental.

func IdentityPoolProviderUrl_DIGITS 

func IdentityPoolProviderUrl_DIGITS() IdentityPoolProviderUrl

func IdentityPoolProviderUrl_FACEBOOK 

func IdentityPoolProviderUrl_FACEBOOK() IdentityPoolProviderUrl

func IdentityPoolProviderUrl_GOOGLE 

func IdentityPoolProviderUrl_GOOGLE() IdentityPoolProviderUrl

func IdentityPoolProviderUrl_OpenId 

func IdentityPoolProviderUrl_OpenId(url *string) IdentityPoolProviderUrl

OpenId Provider Url. Experimental.

func IdentityPoolProviderUrl_Saml 

func IdentityPoolProviderUrl_Saml(url *string) IdentityPoolProviderUrl

Saml Provider Url. Experimental.

func IdentityPoolProviderUrl_TWITTER 

func IdentityPoolProviderUrl_TWITTER() IdentityPoolProviderUrl

func IdentityPoolProviderUrl_UserPool 

func IdentityPoolProviderUrl_UserPool(url *string) IdentityPoolProviderUrl

User Pool Provider Url. Experimental.

func NewIdentityPoolProviderUrl 

func NewIdentityPoolProviderUrl(type_ IdentityPoolProviderType, value *string) IdentityPoolProviderUrl

Experimental.

type IdentityPoolProviders 

type IdentityPoolProviders struct {
	// App Id for Amazon Identity Federation.
	// Experimental.
	Amazon *IdentityPoolAmazonLoginProvider `json:"amazon" yaml:"amazon"`
	// Services Id for Apple Identity Federation.
	// Experimental.
	Apple *IdentityPoolAppleLoginProvider `json:"apple" yaml:"apple"`
	// Consumer Key and Secret for Digits Identity Federation.
	// Experimental.
	Digits *IdentityPoolDigitsLoginProvider `json:"digits" yaml:"digits"`
	// App Id for Facebook Identity Federation.
	// Experimental.
	Facebook *IdentityPoolFacebookLoginProvider `json:"facebook" yaml:"facebook"`
	// Client Id for Google Identity Federation.
	// Experimental.
	Google *IdentityPoolGoogleLoginProvider `json:"google" yaml:"google"`
	// Consumer Key and Secret for Twitter Identity Federation.
	// Experimental.
	Twitter *IdentityPoolTwitterLoginProvider `json:"twitter" yaml:"twitter"`
}

External Identity Providers To Connect to User Pools and Identity Pools.

TODO: EXAMPLE

Experimental.

type IdentityPoolRoleAttachment 

type IdentityPoolRoleAttachment interface {
	awscdk.Resource
	IIdentityPoolRoleAttachment
	Env() *awscdk.ResourceEnvironment
	IdentityPoolId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Defines an Identity Pool Role Attachment.

TODO: EXAMPLE

Experimental.

func NewIdentityPoolRoleAttachment 

func NewIdentityPoolRoleAttachment(scope constructs.Construct, id *string, props *IdentityPoolRoleAttachmentProps) IdentityPoolRoleAttachment

Experimental.

type IdentityPoolRoleAttachmentProps 

type IdentityPoolRoleAttachmentProps struct {
	// Id of the Attachments Underlying Identity Pool.
	// Experimental.
	IdentityPool IIdentityPool `json:"identityPool" yaml:"identityPool"`
	// Default Authenticated (User) Role.
	// Experimental.
	AuthenticatedRole awsiam.IRole `json:"authenticatedRole" yaml:"authenticatedRole"`
	// Rules for mapping roles to users.
	// Experimental.
	RoleMappings *[]*IdentityPoolRoleMapping `json:"roleMappings" yaml:"roleMappings"`
	// Default Unauthenticated (Guest) Role.
	// Experimental.
	UnauthenticatedRole awsiam.IRole `json:"unauthenticatedRole" yaml:"unauthenticatedRole"`
}

Props for an Identity Pool Role Attachment.

TODO: EXAMPLE

Experimental.

type IdentityPoolRoleMapping 

type IdentityPoolRoleMapping struct {
	// The url of the provider of for which the role is mapped.
	// Experimental.
	ProviderUrl IdentityPoolProviderUrl `json:"providerUrl" yaml:"providerUrl"`
	// Allow for role assumption when results of role mapping are ambiguous.
	// Experimental.
	ResolveAmbiguousRoles *bool `json:"resolveAmbiguousRoles" yaml:"resolveAmbiguousRoles"`
	// The claim and value that must be matched in order to assume the role.
	//
	// Required if useToken is false
	// Experimental.
	Rules *[]*RoleMappingRule `json:"rules" yaml:"rules"`
	// If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.
	// See: https://docs.aws.amazon.com/cognito/latest/developerguide/role-based-access-control.html#using-tokens-to-assign-roles-to-users
	//
	// Experimental.
	UseToken *bool `json:"useToken" yaml:"useToken"`
}

Map roles to users in the identity pool based on claims from the Identity Provider.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html

Experimental.

type IdentityPoolTwitterLoginProvider 

type IdentityPoolTwitterLoginProvider struct {
	// App Id for Twitter Identity Federation.
	// Experimental.
	ConsumerKey *string `json:"consumerKey" yaml:"consumerKey"`
	// App Secret for Twitter Identity Federation.
	// Experimental.
	ConsumerSecret *string `json:"consumerSecret" yaml:"consumerSecret"`
}

Login Provider for Identity Federation using Twitter Credentials.

TODO: EXAMPLE

Experimental.

type RoleMappingMatchType 

type RoleMappingMatchType string

Types of matches allowed for Role Mapping.

TODO: EXAMPLE

Experimental. 

const (
	RoleMappingMatchType_EQUALS      RoleMappingMatchType = "EQUALS"
	RoleMappingMatchType_CONTAINS    RoleMappingMatchType = "CONTAINS"
	RoleMappingMatchType_STARTS_WITH RoleMappingMatchType = "STARTS_WITH"
	RoleMappingMatchType_NOTEQUAL    RoleMappingMatchType = "NOTEQUAL"
)

type RoleMappingRule 

type RoleMappingRule struct {
	// The key sent in the token by the federated identity provider.
	// Experimental.
	Claim *string `json:"claim" yaml:"claim"`
	// The value of the claim that must be matched.
	// Experimental.
	ClaimValue *string `json:"claimValue" yaml:"claimValue"`
	// The Role to be assumed when Claim Value is matched.
	// Experimental.
	MappedRole awsiam.IRole `json:"mappedRole" yaml:"mappedRole"`
	// How to match with the Claim value.
	// Experimental.
	MatchType RoleMappingMatchType `json:"matchType" yaml:"matchType"`
}

Represents an Identity Pool Role Attachment Role Mapping Rule.

TODO: EXAMPLE

Experimental.

type UserPoolAuthenticationProvider 

type UserPoolAuthenticationProvider interface {
	IUserPoolAuthenticationProvider
	Bind(scope constructs.Construct, identityPool IIdentityPool, _options *UserPoolAuthenticationProviderBindOptions) *UserPoolAuthenticationProviderBindConfig
}

Defines a User Pool Authentication Provider.

TODO: EXAMPLE

Experimental.

func NewUserPoolAuthenticationProvider 

func NewUserPoolAuthenticationProvider(props *UserPoolAuthenticationProviderProps) UserPoolAuthenticationProvider

Experimental.

type UserPoolAuthenticationProviderBindConfig 

type UserPoolAuthenticationProviderBindConfig struct {
	// Client Id of the Associated User Pool Client.
	// Experimental.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// The identity providers associated with the UserPool.
	// Experimental.
	ProviderName *string `json:"providerName" yaml:"providerName"`
	// Whether to enable the identity pool's server side token check.
	// Experimental.
	ServerSideTokenCheck *bool `json:"serverSideTokenCheck" yaml:"serverSideTokenCheck"`
}

Represents a UserPoolAuthenticationProvider Bind Configuration.

TODO: EXAMPLE

Experimental.

type UserPoolAuthenticationProviderBindOptions 

type UserPoolAuthenticationProviderBindOptions struct {
}

Represents UserPoolAuthenticationProvider Bind Options.

TODO: EXAMPLE

Experimental.

type UserPoolAuthenticationProviderProps 

type UserPoolAuthenticationProviderProps struct {
	// The User Pool of the Associated Identity Providers.
	// Experimental.
	UserPool awscognito.IUserPool `json:"userPool" yaml:"userPool"`
	// Setting this to true turns off identity pool checks for this user pool to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html
	//
	// Experimental.
	DisableServerSideTokenCheck *bool `json:"disableServerSideTokenCheck" yaml:"disableServerSideTokenCheck"`
	// The User Pool Client for the provided User Pool.
	// Experimental.
	UserPoolClient awscognito.IUserPoolClient `json:"userPoolClient" yaml:"userPoolClient"`
}

Props for the User Pool Authentication Provider.

TODO: EXAMPLE

Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.