CfnUserPoolClient
- class aws_cdk.aws_cognito.CfnUserPoolClient(scope, id, *, user_pool_id, access_token_validity=None, allowed_o_auth_flows=None, allowed_o_auth_flows_user_pool_client=None, allowed_o_auth_scopes=None, analytics_configuration=None, auth_session_validity=None, callback_ur_ls=None, client_name=None, default_redirect_uri=None, enable_propagate_additional_user_context_data=None, enable_token_revocation=None, explicit_auth_flows=None, generate_secret=None, id_token_validity=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, token_validity_units=None, write_attributes=None)
Bases:
CfnResource
A CloudFormation
AWS::Cognito::UserPoolClient
.The
AWS::Cognito::UserPoolClient
resource specifies an Amazon Cognito user pool client. .. epigraph:If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.
- CloudformationResource
AWS::Cognito::UserPoolClient
- Link
- ExampleMetadata
lit=test/integ.cognito.lit.ts infused
Example:
import aws_cdk.aws_cognito as cognito import aws_cdk.aws_ec2 as ec2 import aws_cdk.aws_elasticloadbalancingv2 as elbv2 from aws_cdk.core import App, CfnOutput, Stack from constructs import Construct import aws_cdk.aws_elasticloadbalancingv2_actions as actions Stack): lb = elbv2.ApplicationLoadBalancer(self, "LB", vpc=vpc, internet_facing=True ) user_pool = cognito.UserPool(self, "UserPool") user_pool_client = cognito.UserPoolClient(self, "Client", user_pool=user_pool, # Required minimal configuration for use with an ELB generate_secret=True, auth_flows=cognito.AuthFlow( user_password=True ), o_auth=cognito.OAuthSettings( flows=cognito.OAuthFlows( authorization_code_grant=True ), scopes=[cognito.OAuthScope.EMAIL], callback_urls=[f"https://{lb.loadBalancerDnsName}/oauth2/idpresponse" ] ) ) cfn_client = user_pool_client.node.default_child cfn_client.add_property_override("RefreshTokenValidity", 1) cfn_client.add_property_override("SupportedIdentityProviders", ["COGNITO"]) user_pool_domain = cognito.UserPoolDomain(self, "Domain", user_pool=user_pool, cognito_domain=cognito.CognitoDomainOptions( domain_prefix="test-cdk-prefix" ) ) lb.add_listener("Listener", port=443, certificates=[certificate], default_action=actions.AuthenticateCognitoAction( user_pool=user_pool, user_pool_client=user_pool_client, user_pool_domain=user_pool_domain, next=elbv2.ListenerAction.fixed_response(200, content_type="text/plain", message_body="Authenticated" ) ) ) CfnOutput(self, "DNS", value=lb.load_balancer_dns_name ) app = App() CognitoStack(app, "integ-cognito") app.synth()
Create a new
AWS::Cognito::UserPoolClient
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
user_pool_id (
str
) – The user pool ID for the user pool where you want to create a user pool client.access_token_validity (
Union
[int
,float
,None
]) – The access token time limit. After this limit expires, your user can’t use their access token. To specify the time unit forAccessTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request. For example, when you setAccessTokenValidity
to10
andTokenValidityUnits
tohours
, your user can authorize access with their access token for 10 hours. The default time unit forAccessTokenValidity
in an API request is hours.allowed_o_auth_flows (
Optional
[Sequence
[str
]]) – The allowed OAuth flows. - code - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the/oauth2/token
endpoint. - implicit - Issue the access token (and, optionally, ID token, based on scopes) directly to your user. - client_credentials - Issue the access token from the/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.allowed_o_auth_flows_user_pool_client (
Union
[bool
,IResolvable
,None
]) – Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.allowed_o_auth_scopes (
Optional
[Sequence
[str
]]) – The allowed OAuth scopes. Possible values provided by OAuth arephone
,email
,openid
, andprofile
. Possible values provided by AWS areaws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.analytics_configuration (
Union
[IResolvable
,AnalyticsConfigurationProperty
,Dict
[str
,Any
],None
]) – The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. .. epigraph:: In AWS Regions where Amazon Pinpoint isn’t available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.auth_session_validity (
Union
[int
,float
,None
]) – Amazon Cognito creates a session token for each API request in an authentication flow.AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.callback_ur_ls (
Optional
[Sequence
[str
]]) – A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - Be an absolute URI. - Be registered with the authorization server. - Not include a fragment component. See OAuth 2.0 - Redirection Endpoint . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.client_name (
Optional
[str
]) – The client name for the user pool client you would like to create.default_redirect_uri (
Optional
[str
]) –The default redirect URI. Must be in the
CallbackURLs
list. A redirect URI must: - Be an absolute URI. - Be registered with the authorization server. - Not include a fragment component. See OAuth 2.0 - Redirection Endpoint . Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.enable_propagate_additional_user_context_data (
Union
[bool
,IResolvable
,None
]) – Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool . If you don’t include this parameter, you can’t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activateEnablePropagateAdditionalUserContextData
in an app client that has a client secret.enable_token_revocation (
Union
[bool
,IResolvable
,None
]) – Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken . If you don’t include this parameter, token revocation is automatically activated for the new user pool client.explicit_auth_flows (
Optional
[Sequence
[str
]]) – The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:: If you don’t specify a value forExplicitAuthFlows
, your user client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
. Valid values include: -ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. -ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication. -ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. -ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication. -ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens. In some environments, you will see the valuesADMIN_NO_SRP_AUTH
,CUSTOM_AUTH_FLOW_ONLY
, orUSER_PASSWORD_AUTH
. You can’t assign these legacyExplicitAuthFlows
values to user pool clients at the same time as values that begin withALLOW_
, likeALLOW_USER_SRP_AUTH
.generate_secret (
Union
[bool
,IResolvable
,None
]) – Boolean to specify whether you want to generate a secret for the user pool client being created.id_token_validity (
Union
[int
,float
,None
]) – The ID token time limit. After this limit expires, your user can’t use their ID token. To specify the time unit forIdTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request. For example, when you setIdTokenValidity
as10
andTokenValidityUnits
ashours
, your user can authenticate their session with their ID token for 10 hours. The default time unit forAccessTokenValidity
in an API request is hours.logout_ur_ls (
Optional
[Sequence
[str
]]) – A list of allowed logout URLs for the IdPs.prevent_user_existence_errors (
Optional
[str
]) – Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set toENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool.read_attributes (
Optional
[Sequence
[str
]]) – The read attributes.refresh_token_validity (
Union
[int
,float
,None
]) – The refresh token time limit. After this limit expires, your user can’t use their refresh token. To specify the time unit forRefreshTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request. For example, when you setRefreshTokenValidity
as10
andTokenValidityUnits
asdays
, your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit forRefreshTokenValidity
in an API request is days. You can’t setRefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.supported_identity_providers (
Optional
[Sequence
[str
]]) – A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported:COGNITO
,Facebook
,Google
,SignInWithApple
, andLoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for exampleMySAMLIdP
orMyOIDCIdP
.token_validity_units (
Union
[IResolvable
,TokenValidityUnitsProperty
,Dict
[str
,Any
],None
]) – The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.write_attributes (
Optional
[Sequence
[str
]]) – The user pool attributes that the app client can write to. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
- Return type
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
- Return type
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
- to_string()
Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Cognito::UserPoolClient'
- access_token_validity
The access token time limit.
After this limit expires, your user can’t use their access token. To specify the time unit for
AccessTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
AccessTokenValidity
to10
andTokenValidityUnits
tohours
, your user can authorize access with their access token for 10 hours.The default time unit for
AccessTokenValidity
in an API request is hours.
- allowed_o_auth_flows
The allowed OAuth flows.
code - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint.implicit - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentials - Issue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.
- allowed_o_auth_flows_user_pool_client
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
- allowed_o_auth_scopes
The allowed OAuth scopes.
Possible values provided by OAuth are
phone
,email
,openid
, andprofile
. Possible values provided by AWS areaws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
- analytics_configuration
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In AWS Regions where Amazon Pinpoint isn’t available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
- attr_client_secret
ClientSecret
- Type
cloudformationAttribute
- attr_name
Name
- Type
cloudformationAttribute
- auth_session_validity
Amazon Cognito creates a session token for each API request in an authentication flow.
AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
- callback_ur_ls
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- client_name
The client name for the user pool client you would like to create.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- default_redirect_uri
The default redirect URI. Must be in the
CallbackURLs
list.A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
- enable_propagate_additional_user_context_data
Activates the propagation of additional user context data.
For more information about propagation of user context data, see Adding advanced security to a user pool . If you don’t include this parameter, you can’t send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
- enable_token_revocation
//docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ .
If you don’t include this parameter, token revocation is automatically activated for the new user pool client.
- Link
- Type
Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https
- explicit_auth_flows
The authentication flows that you want your user pool client to support.
For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions. .. epigraph:
If you don't specify a value for ``ExplicitAuthFlows`` , your user client supports ``ALLOW_REFRESH_TOKEN_AUTH`` , ``ALLOW_USER_SRP_AUTH`` , and ``ALLOW_CUSTOM_AUTH`` .
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH
,CUSTOM_AUTH_FLOW_ONLY
, orUSER_PASSWORD_AUTH
. You can’t assign these legacyExplicitAuthFlows
values to user pool clients at the same time as values that begin withALLOW_
, likeALLOW_USER_SRP_AUTH
.
- generate_secret
Boolean to specify whether you want to generate a secret for the user pool client being created.
- id_token_validity
The ID token time limit.
After this limit expires, your user can’t use their ID token. To specify the time unit for
IdTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
IdTokenValidity
as10
andTokenValidityUnits
ashours
, your user can authenticate their session with their ID token for 10 hours.The default time unit for
AccessTokenValidity
in an API request is hours.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
- logout_ur_ls
A list of allowed logout URLs for the IdPs.
- node
The construct tree node associated with this construct.
- prevent_user_existence_errors
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool.
- read_attributes
The read attributes.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- refresh_token_validity
The refresh token time limit.
After this limit expires, your user can’t use their refresh token. To specify the time unit for
RefreshTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
RefreshTokenValidity
as10
andTokenValidityUnits
asdays
, your user can refresh their session and retrieve new access and ID tokens for 10 days.The default time unit for
RefreshTokenValidity
in an API request is days. You can’t setRefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- supported_identity_providers
A list of provider names for the identity providers (IdPs) that are supported on this client.
The following are supported:
COGNITO
,Facebook
,Google
,SignInWithApple
, andLoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for exampleMySAMLIdP
orMyOIDCIdP
.
- token_validity_units
The units in which the validity times are represented.
The default unit for RefreshToken is days, and default for ID and access tokens are hours.
- user_pool_id
The user pool ID for the user pool where you want to create a user pool client.
- write_attributes
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AnalyticsConfigurationProperty
- class CfnUserPoolClient.AnalyticsConfigurationProperty(*, application_arn=None, application_id=None, external_id=None, role_arn=None, user_data_shared=None)
Bases:
object
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpointisn’t available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
- Parameters
application_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen user pool client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.application_id (
Optional
[str
]) – The application ID for an Amazon Pinpoint application.external_id (
Optional
[str
]) – The external ID.role_arn (
Optional
[str
]) – The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.user_data_shared (
Union
[bool
,IResolvable
,None
]) – IfUserDataShared
istrue
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cognito as cognito analytics_configuration_property = cognito.CfnUserPoolClient.AnalyticsConfigurationProperty( application_arn="applicationArn", application_id="applicationId", external_id="externalId", role_arn="roleArn", user_data_shared=False )
Attributes
- application_arn
The Amazon Resource Name (ARN) of an Amazon Pinpoint project.
You can use the Amazon Pinpoint project for integration with the chosen user pool client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
- application_id
The application ID for an Amazon Pinpoint application.
- external_id
The external ID.
- role_arn
The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
If
UserDataShared
istrue
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
TokenValidityUnitsProperty
- class CfnUserPoolClient.TokenValidityUnitsProperty(*, access_token=None, id_token=None, refresh_token=None)
Bases:
object
The units in which the validity times are represented.
The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
- Parameters
access_token (
Optional
[str
]) – A time unit ofseconds
,minutes
,hours
, ordays
for the value that you set in theAccessTokenValidity
parameter. The defaultAccessTokenValidity
time unit is hours.id_token (
Optional
[str
]) – A time unit ofseconds
,minutes
,hours
, ordays
for the value that you set in theIdTokenValidity
parameter. The defaultIdTokenValidity
time unit is hours.refresh_token (
Optional
[str
]) – A time unit ofseconds
,minutes
,hours
, ordays
for the value that you set in theRefreshTokenValidity
parameter. The defaultRefreshTokenValidity
time unit is days.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cognito as cognito token_validity_units_property = cognito.CfnUserPoolClient.TokenValidityUnitsProperty( access_token="accessToken", id_token="idToken", refresh_token="refreshToken" )
Attributes
- access_token
A time unit of
seconds
,minutes
,hours
, ordays
for the value that you set in theAccessTokenValidity
parameter.The default
AccessTokenValidity
time unit is hours.
- id_token
A time unit of
seconds
,minutes
,hours
, ordays
for the value that you set in theIdTokenValidity
parameter.The default
IdTokenValidity
time unit is hours.
- refresh_token
A time unit of
seconds
,minutes
,hours
, ordays
for the value that you set in theRefreshTokenValidity
parameter.The default
RefreshTokenValidity
time unit is days.