awsfis

Documentation

Index

• func CfnExperimentTemplate_CFN_RESOURCE_TYPE_NAME() *string
• func CfnExperimentTemplate_IsCfnElement(x interface{}) *bool
• func CfnExperimentTemplate_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnExperimentTemplate_IsConstruct(x interface{}) *bool
• func NewCfnExperimentTemplate_Override(c CfnExperimentTemplate, scope constructs.Construct, id *string, ...)
• type CfnExperimentTemplate
  • func NewCfnExperimentTemplate(scope constructs.Construct, id *string, props *CfnExperimentTemplateProps) CfnExperimentTemplate
• type CfnExperimentTemplateProps
• type CfnExperimentTemplate_ExperimentTemplateActionProperty
• type CfnExperimentTemplate_ExperimentTemplateStopConditionProperty
• type CfnExperimentTemplate_ExperimentTemplateTargetFilterProperty
• type CfnExperimentTemplate_ExperimentTemplateTargetProperty

Functions

func CfnExperimentTemplate_CFN_RESOURCE_TYPE_NAME

func CfnExperimentTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnExperimentTemplate_IsCfnElement

func CfnExperimentTemplate_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element.

func CfnExperimentTemplate_IsCfnResource

func CfnExperimentTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnExperimentTemplate_IsConstruct

func CfnExperimentTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnExperimentTemplate_Override

func NewCfnExperimentTemplate_Override(c CfnExperimentTemplate, scope constructs.Construct, id *string, props *CfnExperimentTemplateProps)

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

Types

type CfnExperimentTemplate

type CfnExperimentTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Actions() interface{}
	SetActions(val interface{})
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	StopConditions() interface{}
	SetStopConditions(val interface{})
	Tags() awscdk.TagManager
	Targets() interface{}
	SetTargets(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) in the *AWS Fault Injection Simulator User Guide* .

TODO: EXAMPLE

func NewCfnExperimentTemplate

func NewCfnExperimentTemplate(scope constructs.Construct, id *string, props *CfnExperimentTemplateProps) CfnExperimentTemplate

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

type CfnExperimentTemplateProps

type CfnExperimentTemplateProps struct {
	// A description for the experiment template.
	Description *string `json:"description" yaml:"description"`
	// The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The stop conditions.
	StopConditions interface{} `json:"stopConditions" yaml:"stopConditions"`
	// The tags to apply to the experiment template.
	Tags *map[string]*string `json:"tags" yaml:"tags"`
	// The targets for the experiment.
	Targets interface{} `json:"targets" yaml:"targets"`
	// The actions for the experiment.
	Actions interface{} `json:"actions" yaml:"actions"`
}

Properties for defining a `CfnExperimentTemplate`.

TODO: EXAMPLE

type CfnExperimentTemplate_ExperimentTemplateActionProperty

type CfnExperimentTemplate_ExperimentTemplateActionProperty struct {
	// The ID of the action.
	//
	// The format of the action ID is: aws: *service-name* : *action-type* .
	ActionId *string `json:"actionId" yaml:"actionId"`
	// A description for the action.
	Description *string `json:"description" yaml:"description"`
	// The parameters for the action, if applicable.
	Parameters interface{} `json:"parameters" yaml:"parameters"`
	// The name of the action that must be completed before the current action starts.
	//
	// Omit this parameter to run the action at the start of the experiment.
	StartAfter *[]*string `json:"startAfter" yaml:"startAfter"`
	// The targets for the action.
	Targets interface{} `json:"targets" yaml:"targets"`
}

Specifies an action for an experiment template.

For more information, see [Actions](https://docs.aws.amazon.com/fis/latest/userguide/actions.html) in the *AWS Fault Injection Simulator User Guide* .

TODO: EXAMPLE

type CfnExperimentTemplate_ExperimentTemplateStopConditionProperty

type CfnExperimentTemplate_ExperimentTemplateStopConditionProperty struct {
	// The source for the stop condition.
	//
	// Specify `aws:cloudwatch:alarm` if the stop condition is defined by a CloudWatch alarm. Specify `none` if there is no stop condition.
	Source *string `json:"source" yaml:"source"`
	// The Amazon Resource Name (ARN) of the CloudWatch alarm.
	//
	// This is required if the source is a CloudWatch alarm.
	Value *string `json:"value" yaml:"value"`
}

Specifies a stop condition for an experiment template.

TODO: EXAMPLE

type CfnExperimentTemplate_ExperimentTemplateTargetFilterProperty

type CfnExperimentTemplate_ExperimentTemplateTargetFilterProperty struct {
	// The attribute path for the filter.
	Path *string `json:"path" yaml:"path"`
	// The attribute values for the filter.
	Values *[]*string `json:"values" yaml:"values"`
}

Specifies a filter used for the target resource input in an experiment template.

For more information, see [Resource filters](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters) in the *AWS Fault Injection Simulator User Guide* .

TODO: EXAMPLE

type CfnExperimentTemplate_ExperimentTemplateTargetProperty

type CfnExperimentTemplate_ExperimentTemplateTargetProperty struct {
	// The resource type.
	//
	// The resource type must be supported for the specified action.
	ResourceType *string `json:"resourceType" yaml:"resourceType"`
	// Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources.
	//
	// All identified resources are included in the target.
	//
	// - ALL - Run the action on all identified targets. This is the default.
	// - COUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random. For example, COUNT(1) selects one of the targets.
	// - PERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets at random. For example, PERCENT(25) selects 25% of the targets.
	SelectionMode *string `json:"selectionMode" yaml:"selectionMode"`
	// The filters to apply to identify target resources using specific attributes.
	Filters interface{} `json:"filters" yaml:"filters"`
	// The Amazon Resource Names (ARNs) of the resources.
	ResourceArns *[]*string `json:"resourceArns" yaml:"resourceArns"`
	// The tags for the target resources.
	ResourceTags interface{} `json:"resourceTags" yaml:"resourceTags"`
}

Specifies a target for an experiment.

You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.

For more information, see [Targets](https://docs.aws.amazon.com/fis/latest/userguide/targets.html) in the *AWS Fault Injection Simulator User Guide* .

TODO: EXAMPLE