software.amazon.awscdk.services.fis

Class CfnExperimentTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.fis.CfnExperimentTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.366Z")
 @Stability(value=Stable)
public class CfnExperimentTemplate
extends CfnResource
implements 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 software.amazon.awscdk.services.fis.*;
 Object cloudWatchLogsConfiguration;
 Object s3Configuration;
 CfnExperimentTemplate cfnExperimentTemplate = CfnExperimentTemplate.Builder.create(this, "MyCfnExperimentTemplate")
         .description("description")
         .roleArn("roleArn")
         .stopConditions(List.of(ExperimentTemplateStopConditionProperty.builder()
                 .source("source")
                 // the properties below are optional
                 .value("value")
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .targets(Map.of(
                 "targetsKey", ExperimentTemplateTargetProperty.builder()
                         .resourceType("resourceType")
                         .selectionMode("selectionMode")
                         // the properties below are optional
                         .filters(List.of(ExperimentTemplateTargetFilterProperty.builder()
                                 .path("path")
                                 .values(List.of("values"))
                                 .build()))
                         .parameters(Map.of(
                                 "parametersKey", "parameters"))
                         .resourceArns(List.of("resourceArns"))
                         .resourceTags(Map.of(
                                 "resourceTagsKey", "resourceTags"))
                         .build()))
         // the properties below are optional
         .actions(Map.of(
                 "actionsKey", ExperimentTemplateActionProperty.builder()
                         .actionId("actionId")
                         // the properties below are optional
                         .description("description")
                         .parameters(Map.of(
                                 "parametersKey", "parameters"))
                         .startAfter(List.of("startAfter"))
                         .targets(Map.of(
                                 "targetsKey", "targets"))
                         .build()))
         .logConfiguration(ExperimentTemplateLogConfigurationProperty.builder()
                 .logSchemaVersion(123)
                 // the properties below are optional
                 .cloudWatchLogsConfiguration(cloudWatchLogsConfiguration)
                 .s3Configuration(s3Configuration)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnExperimentTemplate.Builder A fluent builder for CfnExperimentTemplate.
static interface	CfnExperimentTemplate.ExperimentTemplateActionProperty Specifies an action for an experiment template.
static interface	CfnExperimentTemplate.ExperimentTemplateLogConfigurationProperty Specifies the configuration for experiment logging.
static interface	CfnExperimentTemplate.ExperimentTemplateStopConditionProperty Specifies a stop condition for an experiment template.
static interface	CfnExperimentTemplate.ExperimentTemplateTargetFilterProperty Specifies a filter used for the target resource input in an experiment template.
static interface	CfnExperimentTemplate.ExperimentTemplateTargetProperty Specifies a target for an experiment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnExperimentTemplate(software.constructs.Construct scope, String id, CfnExperimentTemplateProps props) Create a new `AWS::FIS::ExperimentTemplate`.
protected	CfnExperimentTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnExperimentTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActions() The actions for the experiment.
String	getAttrId() The ID of the experiment template.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the experiment template.
Object	getLogConfiguration() The configuration for experiment logging.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
Object	getStopConditions() The stop conditions.
TagManager	getTags() The tags to apply to the experiment template.
Object	getTargets() The targets for the experiment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(IResolvable value) The actions for the experiment.
void	setActions(Map<String,Object> value) The actions for the experiment.
void	setDescription(String value) A description for the experiment template.
void	setLogConfiguration(CfnExperimentTemplate.ExperimentTemplateLogConfigurationProperty value) The configuration for experiment logging.
void	setLogConfiguration(IResolvable value) The configuration for experiment logging.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
void	setStopConditions(IResolvable value) The stop conditions.
void	setStopConditions(List<Object> value) The stop conditions.
void	setTargets(IResolvable value) The targets for the experiment.
void	setTargets(Map<String,Object> value) The targets for the experiment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnExperimentTemplate

protected CfnExperimentTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnExperimentTemplate

protected CfnExperimentTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnExperimentTemplate

@Stability(value=Stable)
public CfnExperimentTemplate(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnExperimentTemplateProps props)

Create a new `AWS::FIS::ExperimentTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the experiment template.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to apply to the experiment template.

getDescription

@Stability(value=Stable)
 @NotNull
public String getDescription()

A description for the experiment template.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

A description for the experiment template.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

getStopConditions

@Stability(value=Stable)
 @NotNull
public Object getStopConditions()

The stop conditions.

setStopConditions

@Stability(value=Stable)
public void setStopConditions(@NotNull
                                                       IResolvable value)

The stop conditions.

setStopConditions

@Stability(value=Stable)
public void setStopConditions(@NotNull
                                                       List<Object> value)

The stop conditions.

getTargets

@Stability(value=Stable)
 @NotNull
public Object getTargets()

The targets for the experiment.

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                IResolvable value)

The targets for the experiment.

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                Map<String,Object> value)

The targets for the experiment.

getActions

@Stability(value=Stable)
 @Nullable
public Object getActions()

The actions for the experiment.

setActions

@Stability(value=Stable)
public void setActions(@Nullable
                                                IResolvable value)

The actions for the experiment.

setActions

@Stability(value=Stable)
public void setActions(@Nullable
                                                Map<String,Object> value)

The actions for the experiment.

getLogConfiguration

@Stability(value=Stable)
 @Nullable
public Object getLogConfiguration()

The configuration for experiment logging.

setLogConfiguration

@Stability(value=Stable)
public void setLogConfiguration(@Nullable
                                                         CfnExperimentTemplate.ExperimentTemplateLogConfigurationProperty value)

The configuration for experiment logging.

setLogConfiguration

@Stability(value=Stable)
public void setLogConfiguration(@Nullable
                                                         IResolvable value)

The configuration for experiment logging.