Class: Aws::CognitoIdentity::Types::CreateIdentityPoolInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentity::Types::CreateIdentityPoolInput
- Defined in:
- gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb
Overview
When making an API call, you may pass CreateIdentityPoolInput data as a hash:
{
identity_pool_name: "IdentityPoolName", # required
allow_unauthenticated_identities: false, # required
allow_classic_flow: false,
supported_login_providers: {
"IdentityProviderName" => "IdentityProviderId",
},
developer_provider_name: "DeveloperProviderName",
open_id_connect_provider_arns: ["ARNString"],
cognito_identity_providers: [
{
provider_name: "CognitoIdentityProviderName",
client_id: "CognitoIdentityProviderClientId",
server_side_token_check: false,
},
],
saml_provider_arns: ["ARNString"],
identity_pool_tags: {
"TagKeysType" => "TagValueType",
},
}
Input to the CreateIdentityPool action.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allow_classic_flow ⇒ Boolean
Enables or disables the Basic (Classic) authentication flow.
-
#allow_unauthenticated_identities ⇒ Boolean
TRUE if the identity pool supports unauthenticated logins.
-
#cognito_identity_providers ⇒ Array<Types::CognitoIdentityProvider>
An array of Amazon Cognito user pools and their client IDs.
-
#developer_provider_name ⇒ String
The "domain" by which Cognito will refer to your users.
-
#identity_pool_name ⇒ String
A string that you provide.
-
#identity_pool_tags ⇒ Hash<String,String>
Tags to assign to the identity pool.
-
#open_id_connect_provider_arns ⇒ Array<String>
The Amazon Resource Names (ARN) of the OpenID Connect providers.
-
#saml_provider_arns ⇒ Array<String>
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
-
#supported_login_providers ⇒ Hash<String,String>
Optional key:value pairs mapping provider names to provider app IDs.
Instance Attribute Details
#allow_classic_flow ⇒ Boolean
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#allow_unauthenticated_identities ⇒ Boolean
TRUE if the identity pool supports unauthenticated logins.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#cognito_identity_providers ⇒ Array<Types::CognitoIdentityProvider>
An array of Amazon Cognito user pools and their client IDs.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#developer_provider_name ⇒ String
The "domain" by which Cognito will refer to your users. This name
acts as a placeholder that allows your backend and the Cognito
service to communicate about the developer provider. For the
DeveloperProviderName
, you can use letters as well as period
(.
), underscore (_
), and dash (-
).
Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#identity_pool_name ⇒ String
A string that you provide.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#identity_pool_tags ⇒ Hash<String,String>
Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#open_id_connect_provider_arns ⇒ Array<String>
The Amazon Resource Names (ARN) of the OpenID Connect providers.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#saml_provider_arns ⇒ Array<String>
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |
#supported_login_providers ⇒ Hash<String,String>
Optional key:value pairs mapping provider names to provider app IDs.
152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 152 class CreateIdentityPoolInput < Struct.new( :identity_pool_name, :allow_unauthenticated_identities, :allow_classic_flow, :supported_login_providers, :developer_provider_name, :open_id_connect_provider_arns, :cognito_identity_providers, :saml_provider_arns, :identity_pool_tags) SENSITIVE = [] include Aws::Structure end |