class CfnExperimentTemplate (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.FIS.CfnExperimentTemplate`
Java	`software.amazon.awscdk.services.fis.CfnExperimentTemplate`
Python	`aws_cdk.aws_fis.CfnExperimentTemplate`
TypeScript	`@aws-cdk/aws-fis` » `CfnExperimentTemplate`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::FIS::ExperimentTemplate.

Specifies an experiment template.

An experiment template includes the following components:

Targets : A target can be a specific resource in your AWS environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
Actions : The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
Stop conditions : If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see Experiment templates in the AWS Fault Injection Simulator User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as fis from '@aws-cdk/aws-fis';

declare const cloudWatchLogsConfiguration: any;
declare const s3Configuration: any;
const cfnExperimentTemplate = new fis.CfnExperimentTemplate(this, 'MyCfnExperimentTemplate', {
  description: 'description',
  roleArn: 'roleArn',
  stopConditions: [{
    source: 'source',

    // the properties below are optional
    value: 'value',
  }],
  tags: {
    tagsKey: 'tags',
  },
  targets: {
    targetsKey: {
      resourceType: 'resourceType',
      selectionMode: 'selectionMode',

      // the properties below are optional
      filters: [{
        path: 'path',
        values: ['values'],
      }],
      parameters: {
        parametersKey: 'parameters',
      },
      resourceArns: ['resourceArns'],
      resourceTags: {
        resourceTagsKey: 'resourceTags',
      },
    },
  },

  // the properties below are optional
  actions: {
    actionsKey: {
      actionId: 'actionId',

      // the properties below are optional
      description: 'description',
      parameters: {
        parametersKey: 'parameters',
      },
      startAfter: ['startAfter'],
      targets: {
        targetsKey: 'targets',
      },
    },
  },
  logConfiguration: {
    logSchemaVersion: 123,

    // the properties below are optional
    cloudWatchLogsConfiguration: cloudWatchLogsConfiguration,
    s3Configuration: s3Configuration,
  },
});

Initializer

new CfnExperimentTemplate(scope: Construct, id: string, props: CfnExperimentTemplateProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnExperimentTemplateProps — - resource properties.

Create a new AWS::FIS::ExperimentTemplate.

Construct Props

Name	Type	Description
description	`string`	A description for the experiment template.
roleArn	`string`	The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
stopConditions	`IResolvable` `\|` `ExperimentTemplateStopConditionProperty` `\|` `IResolvable[]`	The stop conditions.
tags	`{ [string]: string }`	The tags to apply to the experiment template.
targets	`IResolvable` `\| { [string]:` `IResolvable` `\|` `ExperimentTemplateTargetProperty` `}`	The targets for the experiment.
actions?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `ExperimentTemplateActionProperty` `}`	The actions for the experiment.
logConfiguration?	`IResolvable` `\|` `ExperimentTemplateLogConfigurationProperty`	The configuration for experiment logging.

description

Type: string

A description for the experiment template.

roleArn

Type: string

The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.

stopConditions

Type: IResolvable | ExperimentTemplateStopConditionProperty | IResolvable[]

The stop conditions.

targets

Type: IResolvable | { [string]: IResolvable | ExperimentTemplateTargetProperty }

The targets for the experiment.

actions?

Type: IResolvable | { [string]: IResolvable | ExperimentTemplateActionProperty } (optional)

The actions for the experiment.

logConfiguration?

Type: IResolvable | ExperimentTemplateLogConfigurationProperty (optional)

The configuration for experiment logging.

Properties

Name	Type	Description
attrId	`string`	The ID of the experiment template.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
description	`string`	A description for the experiment template.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
roleArn	`string`	The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
stack	`Stack`	The stack in which this element is defined.
stopConditions	`IResolvable` `\|` `ExperimentTemplateStopConditionProperty` `\|` `IResolvable[]`	The stop conditions.
tags	`TagManager`	The tags to apply to the experiment template.
targets	`IResolvable` `\| { [string]:` `IResolvable` `\|` `ExperimentTemplateTargetProperty` `}`	The targets for the experiment.
actions?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `ExperimentTemplateActionProperty` `}`	The actions for the experiment.
logConfiguration?	`IResolvable` `\|` `ExperimentTemplateLogConfigurationProperty`	The configuration for experiment logging.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrId

Type: string

The ID of the experiment template.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

description

Type: string

A description for the experiment template.

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: ConstructNode

The construct tree node associated with this construct.

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 }).

roleArn

Type: string

The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stopConditions

Type: IResolvable | ExperimentTemplateStopConditionProperty | IResolvable[]

The stop conditions.

targets

Type: IResolvable | { [string]: IResolvable | ExperimentTemplateTargetProperty }

The targets for the experiment.

actions?

Type: IResolvable | { [string]: IResolvable | ExperimentTemplateActionProperty } (optional)

The actions for the experiment.

logConfiguration?

Type: IResolvable | ExperimentTemplateLogConfigurationProperty (optional)

The configuration for experiment logging.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

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.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.)

addOverride(path, value)

public 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.

addPropertyDeletionOverride(propertyPath)

public 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.

addPropertyOverride(propertyPath, value)

public 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).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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 TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public 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.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }