class Extension (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppConfig.Extension |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#Extension |
![]() | software.amazon.awscdk.services.appconfig.Extension |
![]() | aws_cdk.aws_appconfig.Extension |
![]() | aws-cdk-lib » aws_appconfig » Extension |
Implements
IConstruct
, IDependable
, IResource
, IExtension
An AWS AppConfig extension.
Example
declare const fn: lambda.Function;
new appconfig.Extension(this, 'MyExtension', {
actions: [
new appconfig.Action({
actionPoints: [appconfig.ActionPoint.ON_DEPLOYMENT_START],
eventDestination: new appconfig.LambdaDestination(fn),
}),
],
});
Initializer
new Extension(scope: Construct, id: string, props: ExtensionProps)
Parameters
- scope
Construct
- id
string
- props
Extension
Props
Construct Props
Name | Type | Description |
---|---|---|
actions | Action [] | The actions for the extension. |
description? | string | A description of the extension. |
extension | string | The name of the extension. |
latest | number | The latest version number of the extension. |
parameters? | Parameter [] | The parameters accepted for the extension. |
actions
Type:
Action
[]
The actions for the extension.
description?
Type:
string
(optional, default: No description.)
A description of the extension.
extensionName?
Type:
string
(optional, default: A name is generated.)
The name of the extension.
latestVersionNumber?
Type:
number
(optional, default: None.)
The latest version number of the extension.
When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
parameters?
Type:
Parameter
[]
(optional, default: None.)
The parameters accepted for the extension.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
extension | string | The Amazon Resource Name (ARN) of the extension. |
extension | string | The ID of the extension. |
extension | number | The version number of the extension. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
actions? | Action [] | The actions for the extension. |
description? | string | The description of the extension. |
latest | number | The latest version number of the extension. |
name? | string | The name of the extension. |
parameters? | Parameter [] | The parameters of the extension. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
extensionArn
Type:
string
The Amazon Resource Name (ARN) of the extension.
extensionId
Type:
string
The ID of the extension.
extensionVersionNumber
Type:
number
The version number of the extension.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
actions?
Type:
Action
[]
(optional)
The actions for the extension.
description?
Type:
string
(optional)
The description of the extension.
latestVersionNumber?
Type:
number
(optional)
The latest version number of the extension.
name?
Type:
string
(optional)
The name of the extension.
parameters?
Type:
Parameter
[]
(optional)
The parameters of the extension.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports an extension into the CDK using its Amazon Resource Name (ARN). |
static from | Imports an extension into the CDK using its attributes. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
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
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromExtensionArn(scope, id, extensionArn)
public static fromExtensionArn(scope: Construct, id: string, extensionArn: string): IExtension
Parameters
- scope
Construct
— The parent construct. - id
string
— The name of the extension construct. - extensionArn
string
— The Amazon Resource Name (ARN) of the extension.
Returns
Imports an extension into the CDK using its Amazon Resource Name (ARN).
static fromExtensionAttributes(scope, id, attrs)
public static fromExtensionAttributes(scope: Construct, id: string, attrs: ExtensionAttributes): IExtension
Parameters
- scope
Construct
— The parent construct. - id
string
— The name of the extension construct. - attrs
Extension
— The attributes of the extension.Attributes
Returns
Imports an extension into the CDK using its attributes.