interface IAppsyncFunction
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppSync.IAppsyncFunction |
 Java | software.amazon.awscdk.services.appsync.IAppsyncFunction |
 Python | aws_cdk.aws_appsync.IAppsyncFunction |
 TypeScript (source) | @aws-cdk/aws-appsync » IAppsyncFunction |
Implemented by
Appsync
Obtainable from
Appsync.fromAppsyncFunctionAttributes()
Interface for AppSync Functions.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| function | string | the ARN of the AppSync function. |
| function | string | the name of this AppSync Function. |
| node | Construct | The construct tree node for this construct. |
| stack | Stack | The stack in which this resource is defined. |
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.
functionArn
Type:
string
the ARN of the AppSync function.
functionId
Type:
string
the name of this AppSync Function.
node
Type:
Construct
The construct tree node for this construct.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
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).