Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
aws-native.cognito.IdentityPool
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
Resource Type definition for AWS::Cognito::IdentityPool
Create IdentityPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IdentityPool(name: string, args: IdentityPoolArgs, opts?: CustomResourceOptions);@overload
def IdentityPool(resource_name: str,
args: IdentityPoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IdentityPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_unauthenticated_identities: Optional[bool] = None,
allow_classic_flow: Optional[bool] = None,
cognito_events: Optional[Any] = None,
cognito_identity_providers: Optional[Sequence[IdentityPoolCognitoIdentityProviderArgs]] = None,
cognito_streams: Optional[IdentityPoolCognitoStreamsArgs] = None,
developer_provider_name: Optional[str] = None,
identity_pool_name: Optional[str] = None,
open_id_connect_provider_arns: Optional[Sequence[str]] = None,
push_sync: Optional[IdentityPoolPushSyncArgs] = None,
saml_provider_arns: Optional[Sequence[str]] = None,
supported_login_providers: Optional[Any] = None)func NewIdentityPool(ctx *Context, name string, args IdentityPoolArgs, opts ...ResourceOption) (*IdentityPool, error)public IdentityPool(string name, IdentityPoolArgs args, CustomResourceOptions? opts = null)
public IdentityPool(String name, IdentityPoolArgs args)
public IdentityPool(String name, IdentityPoolArgs args, CustomResourceOptions options)
type: aws-native:cognito:IdentityPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IdentityPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IdentityPoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IdentityPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IdentityPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IdentityPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const identityPoolResource = new aws_native.cognito.IdentityPool("identityPoolResource", {
allowUnauthenticatedIdentities: false,
allowClassicFlow: false,
cognitoEvents: "any",
cognitoIdentityProviders: [{
clientId: "string",
providerName: "string",
serverSideTokenCheck: false,
}],
cognitoStreams: {
roleArn: "string",
streamName: "string",
streamingStatus: "string",
},
developerProviderName: "string",
identityPoolName: "string",
openIdConnectProviderArns: ["string"],
pushSync: {
applicationArns: ["string"],
roleArn: "string",
},
samlProviderArns: ["string"],
supportedLoginProviders: "any",
});
Coming soon!
IdentityPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The IdentityPool resource accepts the following input properties:
- Allow
Unauthenticated boolIdentities - Allow
Classic boolFlow - Cognito
Events object - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property. - Cognito
Identity List<Pulumi.Providers Aws Native. Cognito. Inputs. Identity Pool Cognito Identity Provider> - Cognito
Streams Pulumi.Aws Native. Cognito. Inputs. Identity Pool Cognito Streams - Developer
Provider stringName - Identity
Pool stringName - Open
Id List<string>Connect Provider Arns - Push
Sync Pulumi.Aws Native. Cognito. Inputs. Identity Pool Push Sync - Saml
Provider List<string>Arns - Supported
Login objectProviders - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property.
- Allow
Unauthenticated boolIdentities - Allow
Classic boolFlow - Cognito
Events interface{} - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property. - Cognito
Identity []IdentityProviders Pool Cognito Identity Provider Args - Cognito
Streams IdentityPool Cognito Streams Args - Developer
Provider stringName - Identity
Pool stringName - Open
Id []stringConnect Provider Arns - Push
Sync IdentityPool Push Sync Args - Saml
Provider []stringArns - Supported
Login interface{}Providers - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property.
- allow
Unauthenticated BooleanIdentities - allow
Classic BooleanFlow - cognito
Events Object - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property. - cognito
Identity List<IdentityProviders Pool Cognito Identity Provider> - cognito
Streams IdentityPool Cognito Streams - developer
Provider StringName - identity
Pool StringName - open
Id List<String>Connect Provider Arns - push
Sync IdentityPool Push Sync - saml
Provider List<String>Arns - supported
Login ObjectProviders - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property.
- allow
Unauthenticated booleanIdentities - allow
Classic booleanFlow - cognito
Events any - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property. - cognito
Identity IdentityProviders Pool Cognito Identity Provider[] - cognito
Streams IdentityPool Cognito Streams - developer
Provider stringName - identity
Pool stringName - open
Id string[]Connect Provider Arns - push
Sync IdentityPool Push Sync - saml
Provider string[]Arns - supported
Login anyProviders - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property.
- allow_
unauthenticated_ boolidentities - allow_
classic_ boolflow - cognito_
events Any - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property. - cognito_
identity_ Sequence[Identityproviders Pool Cognito Identity Provider Args] - cognito_
streams IdentityPool Cognito Streams Args - developer_
provider_ strname - identity_
pool_ strname - open_
id_ Sequence[str]connect_ provider_ arns - push_
sync IdentityPool Push Sync Args - saml_
provider_ Sequence[str]arns - supported_
login_ Anyproviders - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property.
- allow
Unauthenticated BooleanIdentities - allow
Classic BooleanFlow - cognito
Events Any - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property. - cognito
Identity List<Property Map>Providers - cognito
Streams Property Map - developer
Provider StringName - identity
Pool StringName - open
Id List<String>Connect Provider Arns - push
Sync Property Map - saml
Provider List<String>Arns - supported
Login AnyProviders - Search the CloudFormation User Guide for
AWS::Cognito::IdentityPoolfor more information about the expected schema for this property.
Outputs
All input properties are implicitly available as output properties. Additionally, the IdentityPool resource produces the following output properties:
Supporting Types
IdentityPoolCognitoIdentityProvider, IdentityPoolCognitoIdentityProviderArgs
- Client
Id string - Provider
Name string - Server
Side boolToken Check
- Client
Id string - Provider
Name string - Server
Side boolToken Check
- client
Id String - provider
Name String - server
Side BooleanToken Check
- client
Id string - provider
Name string - server
Side booleanToken Check
- client_
id str - provider_
name str - server_
side_ booltoken_ check
- client
Id String - provider
Name String - server
Side BooleanToken Check
IdentityPoolCognitoStreams, IdentityPoolCognitoStreamsArgs
- Role
Arn string - Stream
Name string - Streaming
Status string
- Role
Arn string - Stream
Name string - Streaming
Status string
- role
Arn String - stream
Name String - streaming
Status String
- role
Arn string - stream
Name string - streaming
Status string
- role_
arn str - stream_
name str - streaming_
status str
- role
Arn String - stream
Name String - streaming
Status String
IdentityPoolPushSync, IdentityPoolPushSyncArgs
- Application
Arns List<string> - Role
Arn string
- Application
Arns []string - Role
Arn string
- application
Arns List<String> - role
Arn String
- application
Arns string[] - role
Arn string
- application_
arns Sequence[str] - role_
arn str
- application
Arns List<String> - role
Arn String
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi