class CfnUserPoolClient (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Cognito.CfnUserPoolClient |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolClient |
Java | software.amazon.awscdk.services.cognito.CfnUserPoolClient |
Python | aws_cdk.aws_cognito.CfnUserPoolClient |
TypeScript | 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 user pool ID for the user pool where you want to create a user pool client. |
access | number | The access token time limit. |
allowed | string[] | The OAuth grant types that you want your app client to generate. |
allowed | boolean | IResolvable | Set to true to use OAuth 2.0 features in your user pool app client. |
allowed | string[] | The allowed OAuth scopes. |
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 (callback) URLs for the IdPs. |
client | string | The client name for the user pool client you would like to create. |
default | string | The default redirect URI. Must be in the CallbackURLs list. |
enable | boolean | IResolvable | Activates the propagation of additional user context data. |
enable | boolean | IResolvable | Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken . |
explicit | string[] | The authentication flows that you want your user pool client to support. |
generate | boolean | IResolvable | Boolean to specify whether you want to generate a secret for the user pool client being created. |
id | number | The ID token time limit. |
logout | string[] | A list of allowed logout URLs for the IdPs. |
prevent | string | 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. |
read | string[] | The list of user attributes that you want your app client to have read-only 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 in which the validity times are represented. |
write | string[] | The list of user attributes that you want your app client to have write access to. |
userPoolId
Type:
string
The user pool ID for the user pool where you want to create a user pool 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.
allowedOAuthFlows?
Type:
string[]
(optional)
The OAuth grant types that you want your app client to generate.
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, 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.
allowedOAuthFlowsUserPoolClient?
Type:
boolean |
IResolvable
(optional)
Set to true
to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient
must be 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 OAuth 2.0 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
.
allowedOAuthScopes?
Type:
string[]
(optional)
The allowed OAuth scopes.
Possible values provided by OAuth are phone
, email
, openid
, and profile
. Possible values provided by AWS are aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
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 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.
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 (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.
clientName?
Type:
string
(optional)
The client name for the user pool client you would like to create.
defaultRedirectUri?
Type:
string
(optional)
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.
enablePropagateAdditionalUserContextData?
Type:
boolean |
IResolvable
(optional)
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.
enableTokenRevocation?
Type:
boolean |
IResolvable
(optional)
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.
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 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 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)
Boolean to specify whether you want to generate a secret for the user pool client being created.
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.
logoutUrLs?
Type:
string[]
(optional)
A list of allowed logout URLs for the IdPs.
preventUserExistenceErrors?
Type:
string
(optional)
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 to LEGACY
, those APIs will return a UserNotFoundException
exception if the user does not exist in the user pool.
readAttributes?
Type:
string[]
(optional)
The list of user attributes that you want your app client to have read-only 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. Your app makes a GetUser API request to retrieve and display your user's profile data.
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 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.
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
.
tokenValidityUnits?
Type:
IResolvable
|
Token
(optional)
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.
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. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name
to the new value.
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 user pool ID for the user pool where you want to create a user pool client. |
access | number | The access token time limit. |
allowed | string[] | The OAuth grant types that you want your app client to generate. |
allowed | boolean | IResolvable | Set to true to use OAuth 2.0 features in your user pool app client. |
allowed | string[] | The allowed OAuth scopes. |
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 (callback) URLs for the IdPs. |
client | string | The client name for the user pool client you would like to create. |
default | string | The default redirect URI. |
enable | boolean | IResolvable | Activates the propagation of additional user context data. |
enable | boolean | IResolvable | Activates or deactivates token revocation. |
explicit | string[] | The authentication flows that you want your user pool client to support. |
generate | boolean | IResolvable | Boolean to specify whether you want to generate a secret for the user pool client being created. |
id | number | The ID token time limit. |
logout | string[] | A list of allowed logout URLs for the IdPs. |
prevent | string | 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. |
read | string[] | The list of user attributes that you want your app client to have read-only 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 in which the validity times are represented. |
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 user pool ID for the user pool where you want to create a user pool 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.
allowedOAuthFlowsUserPoolClient?
Type:
boolean |
IResolvable
(optional)
Set to true
to use OAuth 2.0 features in your user pool app client.
allowedOAuthScopes?
Type:
string[]
(optional)
The allowed OAuth scopes.
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 (callback) URLs for the IdPs.
clientName?
Type:
string
(optional)
The client name for the user pool client you would like to create.
defaultRedirectUri?
Type:
string
(optional)
The default redirect URI.
Must be in the CallbackURLs
list.
enablePropagateAdditionalUserContextData?
Type:
boolean |
IResolvable
(optional)
Activates the propagation of additional user context data.
enableTokenRevocation?
Type:
boolean |
IResolvable
(optional)
Activates or deactivates token revocation.
For more information about revoking tokens, see RevokeToken .
explicitAuthFlows?
Type:
string[]
(optional)
The authentication flows that you want your user pool client to support.
generateSecret?
Type:
boolean |
IResolvable
(optional)
Boolean to specify whether you want to generate a secret for the user pool client being created.
idTokenValidity?
Type:
number
(optional)
The ID token time limit.
logoutUrLs?
Type:
string[]
(optional)
A list of allowed logout URLs for the IdPs.
preventUserExistenceErrors?
Type:
string
(optional)
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.
readAttributes?
Type:
string[]
(optional)
The list of user attributes that you want your app client to have read-only 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 in which the validity times are represented.
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 |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
Dependency(target)
addpublic 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.
DependsOn(target)
addpublic 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.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
See also: [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.](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.)
Override(path, value)
addpublic 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.
PropertyDeletionOverride(propertyPath)
addpublic 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.
PropertyOverride(propertyPath, value)
addpublic 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)
.
RemovalPolicy(policy?, options?)
applypublic 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:
Att(attributeName, typeHint?)
getpublic 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.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [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.](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.
Dependencies()
obtainpublic 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.
ResourceDependencies()
obtainpublic obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
LogicalId(newLogicalId)
overridepublic 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.
Dependency(target)
removepublic 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.
Dependency(target, newTarget)
replacepublic 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.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }