class CfnUserPoolClient (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.CfnUserPoolClient |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolClient |
![]() | software.amazon.awscdk.services.cognito.CfnUserPoolClient |
![]() | aws_cdk.aws_cognito.CfnUserPoolClient |
![]() | aws-cdk-lib » aws_cognito » CfnUserPoolClient |
Implements
IConstruct
, IDependable
, IInspectable
The AWS::Cognito::UserPoolClient
resource specifies an Amazon Cognito user pool client.
If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.
Example
import { aws_certificatemanager as acm } from 'aws-cdk-lib';
declare const vpc: ec2.Vpc;
declare const certificate: acm.Certificate;
const lb = new elbv2.ApplicationLoadBalancer(this, 'LB', {
vpc,
internetFacing: true,
});
const userPool = new cognito.UserPool(this, 'UserPool');
const userPoolClient = new cognito.UserPoolClient(this, 'Client', {
userPool,
// Required minimal configuration for use with an ELB
generateSecret: true,
authFlows: {
userPassword: true,
},
oAuth: {
flows: {
authorizationCodeGrant: true,
},
scopes: [cognito.OAuthScope.EMAIL],
callbackUrls: [
`https://${lb.loadBalancerDnsName}/oauth2/idpresponse`,
],
},
});
const cfnClient = userPoolClient.node.defaultChild as cognito.CfnUserPoolClient;
cfnClient.addPropertyOverride('RefreshTokenValidity', 1);
cfnClient.addPropertyOverride('SupportedIdentityProviders', ['COGNITO']);
const userPoolDomain = new cognito.UserPoolDomain(this, 'Domain', {
userPool,
cognitoDomain: {
domainPrefix: 'test-cdk-prefix',
},
});
lb.addListener('Listener', {
port: 443,
certificates: [certificate],
defaultAction: new actions.AuthenticateCognitoAction({
userPool,
userPoolClient,
userPoolDomain,
next: elbv2.ListenerAction.fixedResponse(200, {
contentType: 'text/plain',
messageBody: 'Authenticated',
}),
}),
});
new CfnOutput(this, 'DNS', {
value: lb.loadBalancerDnsName,
});
Initializer
new CfnUserPoolClient(scope: Construct, id: string, props: CfnUserPoolClientProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.User Pool Client Props
Construct Props
Name | Type | Description |
---|---|---|
user | string | The ID of the user pool where you want to create an app client. |
access | number | The access token time limit. |
allowed | string[] | The OAuth grant types that you want your app client to generate for clients in managed login authentication. |
allowed | boolean | IResolvable | Set to true to use OAuth 2.0 authorization server features in your app client. |
allowed | string[] | The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. |
analytics | IResolvable | Analytics | The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. |
auth | number | Amazon Cognito creates a session token for each API request in an authentication flow. |
callback | string[] | A list of allowed redirect, or callback, URLs for managed login authentication. |
client | string | A friendly name for the app client that you want to create. |
default | string | The default redirect URI. |
enable | boolean | IResolvable | When true , your application can include additional UserContextData in authentication requests. |
enable | boolean | IResolvable | Activates or deactivates token revocation. |
explicit | string[] | 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. |
generate | boolean | IResolvable | When true , generates a client secret for the app client. |
id | number | The ID token time limit. |
logout | string[] | A list of allowed logout URLs for managed login authentication. |
prevent | string | Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. |
read | string[] | The list of user attributes that you want your app client to have read access to. |
refresh | number | The refresh token time limit. |
supported | string[] | A list of provider names for the identity providers (IdPs) that are supported on this client. |
token | IResolvable | Token | The units that validity times are represented in. |
write | string[] | The list of user attributes that you want your app client to have write access to. |
userPoolId
Type:
string
The ID of the user pool where you want to create an app client.
accessTokenValidity?
Type:
number
(optional)
The access token time limit.
After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and TokenValidityUnits
to hours
, your user can authorize access with
their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
allowedOAuthFlows?
Type:
string[]
(optional)
The OAuth grant types that you want your app client to generate for clients in managed login authentication.
To create an app client that generates client credentials grants, you must add client_credentials
as the only allowed OAuth flow.
- 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 the ID token when scopes like
openid
andprofile
are requested, directly to your user. - client_credentials - Issue the access token from the
/oauth2/token
endpoint directly to a non-person user, authorized by a combination of the client ID and client secret.
allowedOAuthFlowsUserPoolClient?
Type:
boolean |
IResolvable
(optional)
Set to true
to use OAuth 2.0 authorization server features in your app client.
This parameter must have a value of true
before you can configure the following features in your app client.
CallBackURLs
: Callback URLs.LogoutURLs
: Sign-out redirect URLs.AllowedOAuthScopes
: OAuth 2.0 scopes.AllowedOAuthFlows
: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient
to true
in a CreateUserPoolClient
or UpdateUserPoolClient
API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient
in a request with the AWS CLI or SDKs, it defaults to false
. When false
, only SDK-based API sign-in is permitted.
allowedOAuthScopes?
Type:
string[]
(optional)
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.
Scopes govern access control to user pool self-service API operations, user data from the userInfo
endpoint, and third-party APIs. Scope values include phone
, email
, openid
, and profile
. The aws.cognito.signin.user.admin
scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.
analyticsConfiguration?
Type:
IResolvable
|
Analytics
(optional)
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 might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see Using Amazon Pinpoint analytics .
authSessionValidity?
Type:
number
(optional)
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.
callbackUrLs?
Type:
string[]
(optional)
A list of allowed redirect, or callback, URLs for managed login authentication.
These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.
A redirect URI must meet the following requirements:
- Be an absolute URI.
- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with
redirect_uri
values that aren't in the list ofCallbackURLs
that you provide in this parameter. - 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.
clientName?
Type:
string
(optional)
A friendly name for the app client that you want to create.
defaultRedirectUri?
Type:
string
(optional)
The default redirect URI.
In app clients with one assigned IdP, replaces redirect_uri
in authentication requests. Must be in the CallbackURLs
list.
enablePropagateAdditionalUserContextData?
Type:
boolean |
IResolvable
(optional)
When true
, your application can include additional UserContextData
in authentication requests.
This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests . If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
enableTokenRevocation?
Type:
boolean |
IResolvable
(optional)
Activates or deactivates token revocation.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
explicitAuthFlows?
Type:
string[]
(optional)
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.
If you don't specify a value for
ExplicitAuthFlows
, your app client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.
The values for authentication flow options include the following.
ALLOW_USER_AUTH
: Enable selection-based sign-in withUSER_AUTH
. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without otherExplicitAuthFlows
permitting them. For example users can complete an SRP challenge throughUSER_AUTH
without the flowUSER_SRP_AUTH
being active for the app client. This flow doesn't includeCUSTOM_AUTH
.
To activate this setting, your user pool must be in the Essentials tier or higher.
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
, or USER_PASSWORD_AUTH
. You can't assign these legacy ExplicitAuthFlows
values to user pool clients at the same time as values that begin with ALLOW_
,
like ALLOW_USER_SRP_AUTH
.
generateSecret?
Type:
boolean |
IResolvable
(optional)
When true
, generates a client secret for the app client.
Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types .
idTokenValidity?
Type:
number
(optional)
The ID token time limit.
After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and TokenValidityUnits
as hours
, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
logoutUrLs?
Type:
string[]
(optional)
A list of allowed logout URLs for managed login authentication.
When you pass logout_uri
and client_id
parameters to /logout
, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of logout_uri
. A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint .
preventUserExistenceErrors?
Type:
string
(optional)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED
- This prevents user existence-related errors.LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
Defaults to LEGACY
when you don't provide a value.
readAttributes?
Type:
string[]
(optional)
The list of user attributes that you want your app client to have read access to.
After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information.
When you don't specify the ReadAttributes
for your app client, your app can read the values of email_verified
, phone_number_verified
, and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes
in the API response if you have specified your own custom set of read attributes.
refreshTokenValidity?
Type:
number
(optional)
The refresh token time limit.
After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and TokenValidityUnits
as days
, 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 set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
supportedIdentityProviders?
Type:
string[]
(optional)
A list of provider names for the identity providers (IdPs) that are supported on this client.
The following are supported: COGNITO
, Facebook
, Google
, SignInWithApple
, and LoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
or MyOIDCIdP
.
This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of COGNITO
from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a AWS WAF rule .
tokenValidityUnits?
Type:
IResolvable
|
Token
(optional)
The units that validity times are represented in.
The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
writeAttributes?
Type:
string[]
(optional)
The list of user attributes that you want your app client to have write access to.
After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.
When you don't specify the WriteAttributes
for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes
doesn't return any information. Amazon Cognito only populates WriteAttributes
in the API response if you have specified your own custom set of write attributes.
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 .
Properties
Name | Type | Description |
---|---|---|
attr | string | The ID of the app client, for example 1example23456789 . |
attr | string | |
attr | string | |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
user | string | The ID of the user pool where you want to create an app client. |
access | number | The access token time limit. |
allowed | string[] | The OAuth grant types that you want your app client to generate for clients in managed login authentication. |
allowed | boolean | IResolvable | Set to true to use OAuth 2.0 authorization server features in your app client. |
allowed | string[] | The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. |
analytics | IResolvable | Analytics | The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. |
auth | number | Amazon Cognito creates a session token for each API request in an authentication flow. |
callback | string[] | A list of allowed redirect, or callback, URLs for managed login authentication. |
client | string | A friendly name for the app client that you want to create. |
default | string | The default redirect URI. |
enable | boolean | IResolvable | When true , your application can include additional UserContextData in authentication requests. |
enable | boolean | IResolvable | Activates or deactivates token revocation. |
explicit | string[] | 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. |
generate | boolean | IResolvable | When true , generates a client secret for the app client. |
id | number | The ID token time limit. |
logout | string[] | A list of allowed logout URLs for managed login authentication. |
prevent | string | Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. |
read | string[] | The list of user attributes that you want your app client to have read access to. |
refresh | number | The refresh token time limit. |
supported | string[] | A list of provider names for the identity providers (IdPs) that are supported on this client. |
token | IResolvable | Token | The units that validity times are represented in. |
write | string[] | The list of user attributes that you want your app client to have write access to. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrClientId
Type:
string
The ID of the app client, for example 1example23456789
.
attrClientSecret
Type:
string
attrName
Type:
string
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
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)
.
node
Type:
Node
The tree node.
ref
Type:
string
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
userPoolId
Type:
string
The ID of the user pool where you want to create an app client.
accessTokenValidity?
Type:
number
(optional)
The access token time limit.
allowedOAuthFlows?
Type:
string[]
(optional)
The OAuth grant types that you want your app client to generate for clients in managed login authentication.
allowedOAuthFlowsUserPoolClient?
Type:
boolean |
IResolvable
(optional)
Set to true
to use OAuth 2.0 authorization server features in your app client.
allowedOAuthScopes?
Type:
string[]
(optional)
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.
analyticsConfiguration?
Type:
IResolvable
|
Analytics
(optional)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
authSessionValidity?
Type:
number
(optional)
Amazon Cognito creates a session token for each API request in an authentication flow.
callbackUrLs?
Type:
string[]
(optional)
A list of allowed redirect, or callback, URLs for managed login authentication.
clientName?
Type:
string
(optional)
A friendly name for the app client that you want to create.
defaultRedirectUri?
Type:
string
(optional)
The default redirect URI.
enablePropagateAdditionalUserContextData?
Type:
boolean |
IResolvable
(optional)
When true
, your application can include additional UserContextData
in authentication requests.
enableTokenRevocation?
Type:
boolean |
IResolvable
(optional)
Activates or deactivates token revocation.
explicitAuthFlows?
Type:
string[]
(optional)
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.
generateSecret?
Type:
boolean |
IResolvable
(optional)
When true
, generates a client secret for the app client.
idTokenValidity?
Type:
number
(optional)
The ID token time limit.
logoutUrLs?
Type:
string[]
(optional)
A list of allowed logout URLs for managed login authentication.
preventUserExistenceErrors?
Type:
string
(optional)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
readAttributes?
Type:
string[]
(optional)
The list of user attributes that you want your app client to have read access to.
refreshTokenValidity?
Type:
number
(optional)
The refresh token time limit.
supportedIdentityProviders?
Type:
string[]
(optional)
A list of provider names for the identity providers (IdPs) that are supported on this client.
tokenValidityUnits?
Type:
IResolvable
|
Token
(optional)
The units that validity times are represented in.
writeAttributes?
Type:
string[]
(optional)
The list of user attributes that you want your app client to have write access to.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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.](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.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
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.](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)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }