Skip to content

IRosResourceOptions

Properties

Name Type Description
condition RosCondition A condition to associate with this resource.
count number | IResolvable No description.
deletionPolicy RosDeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
description string No description.
metadata {[ key: string ]: any} Metadata associated with the ROS resource.

conditionOptional 

public readonly condition: RosCondition;

A condition to associate with this resource.

This means that only if the condition evaluates to 'true' when the stack is deployed, the resource will be included. This is provided to allow CDK projects to produce legacy templates, but noramlly there is no need to use it in CDK projects.

countOptional 

public readonly count: number | IResolvable;

deletionPolicyOptional 

public readonly deletionPolicy: RosDeletionPolicy;

With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.

You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, ROS deletes the resource by default. Note that this capability also applies to update operations that lead to resources being removed.

descriptionOptional 

public readonly description: string;
  • Type: string

metadataOptional 

public readonly metadata: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

Metadata associated with the ROS resource.

This is not the same as the construct metadata which can be added using construct.addMetadata(), but would not appear in the ROS template automatically.