CfnResolver L1 construct
The AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema.
Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see Resolver Mapping Template Reference .
When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation.
See Update Behaviors of Stack Resources in the AWS CloudFormation User Guide .
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnResolver = new appsync.CfnResolver(this, 'MyCfnResolver', {
apiId: 'apiId',
fieldName: 'fieldName',
typeName: 'typeName',
// the properties below are optional
cachingConfig: {
ttl: 123,
// the properties below are optional
cachingKeys: ['cachingKeys'],
},
code: 'code',
codeS3Location: 'codeS3Location',
dataSourceName: 'dataSourceName',
kind: 'kind',
maxBatchSize: 123,
metricsConfig: 'metricsConfig',
pipelineConfig: {
functions: ['functions'],
},
requestMappingTemplate: 'requestMappingTemplate',
requestMappingTemplateS3Location: 'requestMappingTemplateS3Location',
responseMappingTemplate: 'responseMappingTemplate',
responseMappingTemplateS3Location: 'responseMappingTemplateS3Location',
runtime: {
name: 'name',
runtimeVersion: 'runtimeVersion',
},
syncConfig: {
conflictDetection: 'conflictDetection',
// the properties below are optional
conflictHandler: 'conflictHandler',
lambdaConflictHandlerConfig: {
lambdaConflictHandlerArn: 'lambdaConflictHandlerArn',
},
},
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync
cfn_resolver = appsync.CfnResolver(self, "MyCfnResolver",
api_id="apiId",
field_name="fieldName",
type_name="typeName",
# the properties below are optional
caching_config=appsync.CfnResolver.CachingConfigProperty(
ttl=123,
# the properties below are optional
caching_keys=["cachingKeys"]
),
code="code",
code_s3_location="codeS3Location",
data_source_name="dataSourceName",
kind="kind",
max_batch_size=123,
metrics_config="metricsConfig",
pipeline_config=appsync.CfnResolver.PipelineConfigProperty(
functions=["functions"]
),
request_mapping_template="requestMappingTemplate",
request_mapping_template_s3_location="requestMappingTemplateS3Location",
response_mapping_template="responseMappingTemplate",
response_mapping_template_s3_location="responseMappingTemplateS3Location",
runtime=appsync.CfnResolver.AppSyncRuntimeProperty(
name="name",
runtime_version="runtimeVersion"
),
sync_config=appsync.CfnResolver.SyncConfigProperty(
conflict_detection="conflictDetection",
# the properties below are optional
conflict_handler="conflictHandler",
lambda_conflict_handler_config=appsync.CfnResolver.LambdaConflictHandlerConfigProperty(
lambda_conflict_handler_arn="lambdaConflictHandlerArn"
)
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appsync.*;
CfnResolver cfnResolver = CfnResolver.Builder.create(this, "MyCfnResolver")
.apiId("apiId")
.fieldName("fieldName")
.typeName("typeName")
// the properties below are optional
.cachingConfig(CachingConfigProperty.builder()
.ttl(123)
// the properties below are optional
.cachingKeys(List.of("cachingKeys"))
.build())
.code("code")
.codeS3Location("codeS3Location")
.dataSourceName("dataSourceName")
.kind("kind")
.maxBatchSize(123)
.metricsConfig("metricsConfig")
.pipelineConfig(PipelineConfigProperty.builder()
.functions(List.of("functions"))
.build())
.requestMappingTemplate("requestMappingTemplate")
.requestMappingTemplateS3Location("requestMappingTemplateS3Location")
.responseMappingTemplate("responseMappingTemplate")
.responseMappingTemplateS3Location("responseMappingTemplateS3Location")
.runtime(AppSyncRuntimeProperty.builder()
.name("name")
.runtimeVersion("runtimeVersion")
.build())
.syncConfig(SyncConfigProperty.builder()
.conflictDetection("conflictDetection")
// the properties below are optional
.conflictHandler("conflictHandler")
.lambdaConflictHandlerConfig(LambdaConflictHandlerConfigProperty.builder()
.lambdaConflictHandlerArn("lambdaConflictHandlerArn")
.build())
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var cfnResolver = new CfnResolver(this, "MyCfnResolver", new CfnResolverProps {
ApiId = "apiId",
FieldName = "fieldName",
TypeName = "typeName",
// the properties below are optional
CachingConfig = new CachingConfigProperty {
Ttl = 123,
// the properties below are optional
CachingKeys = new [] { "cachingKeys" }
},
Code = "code",
CodeS3Location = "codeS3Location",
DataSourceName = "dataSourceName",
Kind = "kind",
MaxBatchSize = 123,
MetricsConfig = "metricsConfig",
PipelineConfig = new PipelineConfigProperty {
Functions = new [] { "functions" }
},
RequestMappingTemplate = "requestMappingTemplate",
RequestMappingTemplateS3Location = "requestMappingTemplateS3Location",
ResponseMappingTemplate = "responseMappingTemplate",
ResponseMappingTemplateS3Location = "responseMappingTemplateS3Location",
Runtime = new AppSyncRuntimeProperty {
Name = "name",
RuntimeVersion = "runtimeVersion"
},
SyncConfig = new SyncConfigProperty {
ConflictDetection = "conflictDetection",
// the properties below are optional
ConflictHandler = "conflictHandler",
LambdaConflictHandlerConfig = new LambdaConflictHandlerConfigProperty {
LambdaConflictHandlerArn = "lambdaConflictHandlerArn"
}
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnResolver := awscdk.Aws_appsync.NewCfnResolver(this, jsii.String("MyCfnResolver"), &CfnResolverProps{
ApiId: jsii.String("apiId"),
FieldName: jsii.String("fieldName"),
TypeName: jsii.String("typeName"),
// the properties below are optional
CachingConfig: &CachingConfigProperty{
Ttl: jsii.Number(123),
// the properties below are optional
CachingKeys: []*string{
jsii.String("cachingKeys"),
},
},
Code: jsii.String("code"),
CodeS3Location: jsii.String("codeS3Location"),
DataSourceName: jsii.String("dataSourceName"),
Kind: jsii.String("kind"),
MaxBatchSize: jsii.Number(123),
MetricsConfig: jsii.String("metricsConfig"),
PipelineConfig: &PipelineConfigProperty{
Functions: []*string{
jsii.String("functions"),
},
},
RequestMappingTemplate: jsii.String("requestMappingTemplate"),
RequestMappingTemplateS3Location: jsii.String("requestMappingTemplateS3Location"),
ResponseMappingTemplate: jsii.String("responseMappingTemplate"),
ResponseMappingTemplateS3Location: jsii.String("responseMappingTemplateS3Location"),
Runtime: &AppSyncRuntimeProperty{
Name: jsii.String("name"),
RuntimeVersion: jsii.String("runtimeVersion"),
},
SyncConfig: &SyncConfigProperty{
ConflictDetection: jsii.String("conflictDetection"),
// the properties below are optional
ConflictHandler: jsii.String("conflictHandler"),
LambdaConflictHandlerConfig: &LambdaConflictHandlerConfigProperty{
LambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"),
},
},
})
Initializer
ts
new CfnResolver(scope: Construct, id: string, props: CfnResolverProps)
python
CfnResolver(scope: Construct, id: str, props: CfnResolverProps)
java
new CfnResolver(Construct scope, String id, CfnResolverProps props)
csharp
new CfnResolver(Construct scope, string id, CfnResolverProps props)
go
NewCfnResolver(Scope Construct, Id *string, Props CfnResolverProps)
Construct Props
The AWS AppSync GraphQL API to which you want to attach this resolver.
cachingConfigoptionalIResolvable | CfnResolver.CachingConfigPropertycaching_configoptionaltyping.Union[IResolvable, CachingConfigProperty]cachingConfigoptionalIResolvableCachingConfigoptionalIResolvableCachingConfigoptionalinterface{}#The caching configuration for the resolver.
The `resolver` code that contains the request and response functions.
When code is used, the runtime is required. The runtime value must be APPSYNC_JS .
codeS3Locationoptionalstringcode_s3_locationoptionalstrcodeS3LocationoptionalStringCodeS3LocationoptionalstringCodeS3Locationoptional*string#The Amazon S3 endpoint.
dataSourceNameoptionalstringdata_source_nameoptionalstrdataSourceNameoptionalStringDataSourceNameoptionalstringDataSourceNameoptional*string#The resolver data source name.
The GraphQL field on a type that invokes the resolver.
The resolver type.
notes
- UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
- PIPELINE : A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of
Functionobjects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
maxBatchSizeoptionalnumbermax_batch_sizeoptionalint | floatmaxBatchSizeoptionalNumberMaxBatchSizeoptionaldoubleMaxBatchSizeoptional*float64#The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
metricsConfigoptionalstringmetrics_configoptionalstrmetricsConfigoptionalStringMetricsConfigoptionalstringMetricsConfigoptional*string#Enables or disables enhanced resolver metrics for specified resolvers.
notes
Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
pipelineConfigoptionalIResolvable | CfnResolver.PipelineConfigPropertypipeline_configoptionaltyping.Union[IResolvable, PipelineConfigProperty]pipelineConfigoptionalIResolvablePipelineConfigoptionalIResolvablePipelineConfigoptionalinterface{}#Functions linked with the pipeline resolver.
requestMappingTemplateoptionalstringrequest_mapping_templateoptionalstrrequestMappingTemplateoptionalStringRequestMappingTemplateoptionalstringRequestMappingTemplateoptional*string#The request mapping template.
Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
requestMappingTemplateS3Locationoptionalstringrequest_mapping_template_s3_locationoptionalstrrequestMappingTemplateS3LocationoptionalStringRequestMappingTemplateS3LocationoptionalstringRequestMappingTemplateS3Locationoptional*string#The location of a request mapping template in an Amazon S3 bucket.
Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
responseMappingTemplateoptionalstringresponse_mapping_templateoptionalstrresponseMappingTemplateoptionalStringResponseMappingTemplateoptionalstringResponseMappingTemplateoptional*string#The response mapping template.
responseMappingTemplateS3Locationoptionalstringresponse_mapping_template_s3_locationoptionalstrresponseMappingTemplateS3LocationoptionalStringResponseMappingTemplateS3LocationoptionalstringResponseMappingTemplateS3Locationoptional*string#The location of a response mapping template in an Amazon S3 bucket.
Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
runtimeoptionalIResolvable | CfnResolver.AppSyncRuntimePropertyruntimeoptionaltyping.Union[IResolvable, AppSyncRuntimeProperty]runtimeoptionalIResolvableRuntimeoptionalIResolvableRuntimeoptionalinterface{}#Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
syncConfigoptionalIResolvable | CfnResolver.SyncConfigPropertysync_configoptionaltyping.Union[IResolvable, SyncConfigProperty]syncConfigoptionalIResolvableSyncConfigoptionalIResolvableSyncConfigoptionalinterface{}#The `SyncConfig` for a resolver attached to a versioned data source.
The GraphQL type that invokes this resolver.
Properties
The AWS AppSync GraphQL API to which you want to attach this resolver.
The GraphQL field on a type that invokes the resolver.
attrResolverArnstringattr_resolver_arnstrattrResolverArnStringAttrResolverArnstringAttrResolverArn*string#ARN of the resolver, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername` .
The GraphQL type that invokes this resolver.
cachingConfigmay be undefinedIResolvable | CfnResolver.CachingConfigPropertycaching_configmay be undefinedtyping.Union[IResolvable, CachingConfigProperty]cachingConfigmay be undefinedIResolvableCachingConfigmay be undefinedIResolvableCachingConfigmay be undefinedinterface{}#The caching configuration for the resolver.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#AWS resource type.
codemay be undefinedstringcodemay be undefinedstrcodemay be undefinedStringCodemay be undefinedstringCodemay be undefined*string#The `resolver` code that contains the request and response functions.
codeS3Locationmay be undefinedstringcode_s3_locationmay be undefinedstrcodeS3Locationmay be undefinedStringCodeS3Locationmay be undefinedstringCodeS3Locationmay be undefined*string#The Amazon S3 endpoint.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#dataSourceNamemay be undefinedstringdata_source_namemay be undefinedstrdataSourceNamemay be undefinedStringDataSourceNamemay be undefinedstringDataSourceNamemay be undefined*string#The resolver data source name.
The GraphQL field on a type that invokes the resolver.
kindmay be undefinedstringkindmay be undefinedstrkindmay be undefinedStringKindmay be undefinedstringKindmay be undefined*string#The resolver type.
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).
maxBatchSizemay be undefinednumbermax_batch_sizemay be undefinedint | floatmaxBatchSizemay be undefinedNumberMaxBatchSizemay be undefineddoubleMaxBatchSizemay be undefined*float64#The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
metricsConfigmay be undefinedstringmetrics_configmay be undefinedstrmetricsConfigmay be undefinedStringMetricsConfigmay be undefinedstringMetricsConfigmay be undefined*string#Enables or disables enhanced resolver metrics for specified resolvers.
pipelineConfigmay be undefinedIResolvable | CfnResolver.PipelineConfigPropertypipeline_configmay be undefinedtyping.Union[IResolvable, PipelineConfigProperty]pipelineConfigmay be undefinedIResolvablePipelineConfigmay be undefinedIResolvablePipelineConfigmay be undefinedinterface{}#Functions linked with the pipeline resolver.
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 }).
requestMappingTemplatemay be undefinedstringrequest_mapping_templatemay be undefinedstrrequestMappingTemplatemay be undefinedStringRequestMappingTemplatemay be undefinedstringRequestMappingTemplatemay be undefined*string#The request mapping template.
requestMappingTemplateS3Locationmay be undefinedstringrequest_mapping_template_s3_locationmay be undefinedstrrequestMappingTemplateS3Locationmay be undefinedStringRequestMappingTemplateS3Locationmay be undefinedstringRequestMappingTemplateS3Locationmay be undefined*string#The location of a request mapping template in an Amazon S3 bucket.
resolverRefResolverReferenceresolver_refResolverReferenceresolverRefResolverReferenceResolverRefResolverReferenceResolverRefResolverReference#A reference to a Resolver resource.
responseMappingTemplatemay be undefinedstringresponse_mapping_templatemay be undefinedstrresponseMappingTemplatemay be undefinedStringResponseMappingTemplatemay be undefinedstringResponseMappingTemplatemay be undefined*string#The response mapping template.
responseMappingTemplateS3Locationmay be undefinedstringresponse_mapping_template_s3_locationmay be undefinedstrresponseMappingTemplateS3Locationmay be undefinedStringResponseMappingTemplateS3Locationmay be undefinedstringResponseMappingTemplateS3Locationmay be undefined*string#The location of a response mapping template in an Amazon S3 bucket.
runtimemay be undefinedIResolvable | CfnResolver.AppSyncRuntimePropertyruntimemay be undefinedtyping.Union[IResolvable, AppSyncRuntimeProperty]runtimemay be undefinedIResolvableRuntimemay be undefinedIResolvableRuntimemay be undefinedinterface{}#Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
syncConfigmay be undefinedIResolvable | CfnResolver.SyncConfigPropertysync_configmay be undefinedtyping.Union[IResolvable, SyncConfigProperty]syncConfigmay be undefinedIResolvableSyncConfigmay be undefinedIResolvableSyncConfigmay be undefinedinterface{}#The `SyncConfig` for a resolver attached to a versioned data source.
The GraphQL type that invokes this resolver.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"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.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
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:
arnForResolver(resource: IResolverRef): string@staticmethod def arn_for_resolver(resource: IResolverRef) -> strpublic static String arnForResolver(IResolverRef resource)public static string ArnForResolver(IResolverRef resource)func ArnForResolver(Resource IResolverRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#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.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#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.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResolver(x: any): boolean@staticmethod def is_cfn_resolver(x: Any) -> boolpublic static Boolean isCfnResolver(Object x)public static bool IsCfnResolver(object x)func IsCfnResolver(X interface{}) *boolstatic#Checks whether the given object is a CfnResolver.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#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: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.