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.

IdentityPool

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

type IdentityPool struct { AllowUnauthenticatedIdentities *bool `type:"boolean" required:"true"` CognitoIdentityProviders []*Provider `type:"list"` DeveloperProviderName *string `min:"1" type:"string"` IdentityPoolId *string `min:"1" type:"string" required:"true"` IdentityPoolName *string `min:"1" type:"string" required:"true"` OpenIdConnectProviderARNs []*string `type:"list"` SamlProviderARNs []*string `type:"list"` SupportedLoginProviders map[string]*string `type:"map"` }

An object representing an Amazon Cognito identity pool.

AllowUnauthenticatedIdentities

Type: *bool

TRUE if the identity pool supports unauthenticated logins.

AllowUnauthenticatedIdentities is a required field

CognitoIdentityProviders

A provider representing an Amazon Cognito Identity User Pool and its client ID.

DeveloperProviderName

Type: *string

The "domain" by which Cognito will refer to your users.

IdentityPoolId

Type: *string

An identity pool ID in the format REGION:GUID.

IdentityPoolId is a required field

IdentityPoolName

Type: *string

A string that you provide.

IdentityPoolName is a required field

OpenIdConnectProviderARNs

Type: []*string

A list of OpendID Connect provider ARNs.

SamlProviderARNs

Type: []*string

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

SupportedLoginProviders

Type: map[string]*string

Optional key:value pairs mapping provider names to provider app IDs.

Method

GoString

func (s IdentityPool) GoString() string

GoString returns the string representation

SetAllowUnauthenticatedIdentities

func (s *IdentityPool) SetAllowUnauthenticatedIdentities(v bool) *IdentityPool

SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.

SetCognitoIdentityProviders

func (s *IdentityPool) SetCognitoIdentityProviders(v []*Provider) *IdentityPool

SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.

SetDeveloperProviderName

func (s *IdentityPool) SetDeveloperProviderName(v string) *IdentityPool

SetDeveloperProviderName sets the DeveloperProviderName field's value.

SetIdentityPoolId

func (s *IdentityPool) SetIdentityPoolId(v string) *IdentityPool

SetIdentityPoolId sets the IdentityPoolId field's value.

SetIdentityPoolName

func (s *IdentityPool) SetIdentityPoolName(v string) *IdentityPool

SetIdentityPoolName sets the IdentityPoolName field's value.

SetOpenIdConnectProviderARNs

func (s *IdentityPool) SetOpenIdConnectProviderARNs(v []*string) *IdentityPool

SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.

SetSamlProviderARNs

func (s *IdentityPool) SetSamlProviderARNs(v []*string) *IdentityPool

SetSamlProviderARNs sets the SamlProviderARNs field's value.

SetSupportedLoginProviders

func (s *IdentityPool) SetSupportedLoginProviders(v map[string]*string) *IdentityPool

SetSupportedLoginProviders sets the SupportedLoginProviders field's value.

String

func (s IdentityPool) String() string

String returns the string representation

Validate

func (s *IdentityPool) Validate() error

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

On this page: