Class CfnExperimentTemplate

Specifies an experiment template.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnExperimentTemplate

Implements

IInspectable

IExperimentTemplateRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.FIS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnExperimentTemplate : CfnResource, IInspectable, IExperimentTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnExperimentTemplate Inherits CfnResource Implements IInspectable, IExperimentTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.FIS;

             var cloudWatchLogsConfiguration;
             var s3Configuration;

             var cfnExperimentTemplate = new CfnExperimentTemplate(this, "MyCfnExperimentTemplate", new CfnExperimentTemplateProps {
                 Description = "description",
                 RoleArn = "roleArn",
                 StopConditions = new [] { new ExperimentTemplateStopConditionProperty {
                     Source = "source",

                     // the properties below are optional
                     Value = "value"
                 } },
                 Targets = new Dictionary<string, object> {
                     { "targetsKey", new ExperimentTemplateTargetProperty {
                         ResourceType = "resourceType",
                         SelectionMode = "selectionMode",

                         // the properties below are optional
                         Filters = new [] { new ExperimentTemplateTargetFilterProperty {
                             Path = "path",
                             Values = new [] { "values" }
                         } },
                         Parameters = new Dictionary<string, string> {
                             { "parametersKey", "parameters" }
                         },
                         ResourceArns = new [] { "resourceArns" },
                         ResourceTags = new Dictionary<string, string> {
                             { "resourceTagsKey", "resourceTags" }
                         }
                     } }
                 },

                 // the properties below are optional
                 Actions = new Dictionary<string, object> {
                     { "actionsKey", new ExperimentTemplateActionProperty {
                         ActionId = "actionId",

                         // the properties below are optional
                         Description = "description",
                         Parameters = new Dictionary<string, string> {
                             { "parametersKey", "parameters" }
                         },
                         StartAfter = new [] { "startAfter" },
                         Targets = new Dictionary<string, string> {
                             { "targetsKey", "targets" }
                         }
                     } }
                 },
                 ExperimentOptions = new ExperimentTemplateExperimentOptionsProperty {
                     AccountTargeting = "accountTargeting",
                     EmptyTargetResolutionMode = "emptyTargetResolutionMode"
                 },
                 ExperimentReportConfiguration = new ExperimentTemplateExperimentReportConfigurationProperty {
                     Outputs = new OutputsProperty {
                         ExperimentReportS3Configuration = new ExperimentReportS3ConfigurationProperty {
                             BucketName = "bucketName",

                             // the properties below are optional
                             Prefix = "prefix"
                         }
                     },

                     // the properties below are optional
                     DataSources = new DataSourcesProperty {
                         CloudWatchDashboards = new [] { new CloudWatchDashboardProperty {
                             DashboardIdentifier = "dashboardIdentifier"
                         } }
                     },
                     PostExperimentDuration = "postExperimentDuration",
                     PreExperimentDuration = "preExperimentDuration"
                 },
                 LogConfiguration = new ExperimentTemplateLogConfigurationProperty {
                     LogSchemaVersion = 123,

                     // the properties below are optional
                     CloudWatchLogsConfiguration = cloudWatchLogsConfiguration,
                     S3Configuration = s3Configuration
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnExperimentTemplate(Construct, string, ICfnExperimentTemplateProps)

Create a new AWS::FIS::ExperimentTemplate.

Properties

Actions	The actions for the experiment.
AttrId	The ID of the experiment template.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Specifies an experiment template.
CfnPropertyNames	Specifies an experiment template.
Description	The description for the experiment template.
ExperimentOptions	The experiment options for an experiment template.
ExperimentReportConfiguration	Describes the report configuration for the experiment template.
ExperimentTemplateRef	A reference to a ExperimentTemplate resource.
LogConfiguration	The configuration for experiment logging.
RoleArn	The Amazon Resource Name (ARN) of an IAM role.
StopConditions	The stop conditions for the experiment.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The tags for the experiment template.
Targets	The targets for the experiment.

Methods

ArnForExperimentTemplate(IExperimentTemplateRef)	Specifies an experiment template.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnExperimentTemplate(object)	Checks whether the given object is a CfnExperimentTemplate.
RenderProperties(IDictionary<string, object>)	Specifies an experiment template.

Constructors

CfnExperimentTemplate(Construct, string, ICfnExperimentTemplateProps)

Create a new AWS::FIS::ExperimentTemplate.

public CfnExperimentTemplate(Construct scope, string id, ICfnExperimentTemplateProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnExperimentTemplateProps

Resource properties.

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

Properties

Actions

The actions for the experiment.

public virtual object? Actions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnExperimentTemplate.IExperimentTemplateActionProperty>

AttrId

The ID of the experiment template.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

CfnProperties

Specifies an experiment template.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

CfnPropertyNames

Specifies an experiment template.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

Description

The description for the experiment template.

public virtual string Description { get; set; }

Property Value

string

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

ExperimentOptions

The experiment options for an experiment template.

public virtual object? ExperimentOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnExperimentTemplate.IExperimentTemplateExperimentOptionsProperty

ExperimentReportConfiguration

Describes the report configuration for the experiment template.

public virtual object? ExperimentReportConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnExperimentTemplate.IExperimentTemplateExperimentReportConfigurationProperty

ExperimentTemplateRef

A reference to a ExperimentTemplate resource.

public virtual IExperimentTemplateReference ExperimentTemplateRef { get; }

Property Value

IExperimentTemplateReference

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

LogConfiguration

The configuration for experiment logging.

public virtual object? LogConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnExperimentTemplate.IExperimentTemplateLogConfigurationProperty

RoleArn

The Amazon Resource Name (ARN) of an IAM role.

public virtual string RoleArn { get; set; }

Property Value

string

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

StopConditions

The stop conditions for the experiment.

public virtual object StopConditions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnExperimentTemplate.IExperimentTemplateStopConditionProperty)[]

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

TagsRaw

The tags for the experiment template.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

Targets

The targets for the experiment.

public virtual object Targets { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnExperimentTemplate.IExperimentTemplateTargetProperty>

Methods

ArnForExperimentTemplate(IExperimentTemplateRef)

Specifies an experiment template.

public static string ArnForExperimentTemplate(IExperimentTemplateRef resource)

Parameters

resource IExperimentTemplateRef

Returns

string

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.FIS;

             var cloudWatchLogsConfiguration;
             var s3Configuration;

             var cfnExperimentTemplate = new CfnExperimentTemplate(this, "MyCfnExperimentTemplate", new CfnExperimentTemplateProps {
                 Description = "description",
                 RoleArn = "roleArn",
                 StopConditions = new [] { new ExperimentTemplateStopConditionProperty {
                     Source = "source",

                     // the properties below are optional
                     Value = "value"
                 } },
                 Targets = new Dictionary<string, object> {
                     { "targetsKey", new ExperimentTemplateTargetProperty {
                         ResourceType = "resourceType",
                         SelectionMode = "selectionMode",

                         // the properties below are optional
                         Filters = new [] { new ExperimentTemplateTargetFilterProperty {
                             Path = "path",
                             Values = new [] { "values" }
                         } },
                         Parameters = new Dictionary<string, string> {
                             { "parametersKey", "parameters" }
                         },
                         ResourceArns = new [] { "resourceArns" },
                         ResourceTags = new Dictionary<string, string> {
                             { "resourceTagsKey", "resourceTags" }
                         }
                     } }
                 },

                 // the properties below are optional
                 Actions = new Dictionary<string, object> {
                     { "actionsKey", new ExperimentTemplateActionProperty {
                         ActionId = "actionId",

                         // the properties below are optional
                         Description = "description",
                         Parameters = new Dictionary<string, string> {
                             { "parametersKey", "parameters" }
                         },
                         StartAfter = new [] { "startAfter" },
                         Targets = new Dictionary<string, string> {
                             { "targetsKey", "targets" }
                         }
                     } }
                 },
                 ExperimentOptions = new ExperimentTemplateExperimentOptionsProperty {
                     AccountTargeting = "accountTargeting",
                     EmptyTargetResolutionMode = "emptyTargetResolutionMode"
                 },
                 ExperimentReportConfiguration = new ExperimentTemplateExperimentReportConfigurationProperty {
                     Outputs = new OutputsProperty {
                         ExperimentReportS3Configuration = new ExperimentReportS3ConfigurationProperty {
                             BucketName = "bucketName",

                             // the properties below are optional
                             Prefix = "prefix"
                         }
                     },

                     // the properties below are optional
                     DataSources = new DataSourcesProperty {
                         CloudWatchDashboards = new [] { new CloudWatchDashboardProperty {
                             DashboardIdentifier = "dashboardIdentifier"
                         } }
                     },
                     PostExperimentDuration = "postExperimentDuration",
                     PreExperimentDuration = "preExperimentDuration"
                 },
                 LogConfiguration = new ExperimentTemplateLogConfigurationProperty {
                     LogSchemaVersion = 123,

                     // the properties below are optional
                     CloudWatchLogsConfiguration = cloudWatchLogsConfiguration,
                     S3Configuration = s3Configuration
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

IsCfnExperimentTemplate(object)

Checks whether the given object is a CfnExperimentTemplate.

public static bool IsCfnExperimentTemplate(object x)

Parameters

x object

Returns

bool

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies an experiment template.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

An experiment template includes the following components:

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-experimenttemplate.html

CloudformationResource: AWS::FIS::ExperimentTemplate

ExampleMetadata: fixture=_generated

Implements

IInspectable

IExperimentTemplateRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable