CfnExperimentTemplate
- class aws_cdk.aws_fis.CfnExperimentTemplate(scope, id, *, description, role_arn, stop_conditions, tags, targets, actions=None, log_configuration=None)
Bases:
CfnResource
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 .
- CloudformationResource:
AWS::FIS::ExperimentTemplate
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis # cloud_watch_logs_configuration: Any # s3_configuration: Any cfn_experiment_template = fis.CfnExperimentTemplate(self, "MyCfnExperimentTemplate", description="description", role_arn="roleArn", stop_conditions=[fis.CfnExperimentTemplate.ExperimentTemplateStopConditionProperty( source="source", # the properties below are optional value="value" )], tags={ "tags_key": "tags" }, targets={ "targets_key": fis.CfnExperimentTemplate.ExperimentTemplateTargetProperty( resource_type="resourceType", selection_mode="selectionMode", # the properties below are optional filters=[fis.CfnExperimentTemplate.ExperimentTemplateTargetFilterProperty( path="path", values=["values"] )], parameters={ "parameters_key": "parameters" }, resource_arns=["resourceArns"], resource_tags={ "resource_tags_key": "resourceTags" } ) }, # the properties below are optional actions={ "actions_key": fis.CfnExperimentTemplate.ExperimentTemplateActionProperty( action_id="actionId", # the properties below are optional description="description", parameters={ "parameters_key": "parameters" }, start_after=["startAfter"], targets={ "targets_key": "targets" } ) }, log_configuration=fis.CfnExperimentTemplate.ExperimentTemplateLogConfigurationProperty( log_schema_version=123, # the properties below are optional cloud_watch_logs_configuration=cloud_watch_logs_configuration, s3_configuration=s3_configuration ) )
Create a new
AWS::FIS::ExperimentTemplate
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
description (
str
) – A description for the experiment template.role_arn (
str
) – The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.stop_conditions (
Union
[IResolvable
,Sequence
[Union
[ExperimentTemplateStopConditionProperty
,Dict
[str
,Any
],IResolvable
]]]) – The stop conditions.tags (
Mapping
[str
,str
]) – The tags to apply to the experiment template.targets (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ExperimentTemplateTargetProperty
,Dict
[str
,Any
]]]]) – The targets for the experiment.actions (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ExperimentTemplateActionProperty
,Dict
[str
,Any
]]],None
]) – The actions for the experiment.log_configuration (
Union
[IResolvable
,ExperimentTemplateLogConfigurationProperty
,Dict
[str
,Any
],None
]) – The configuration for experiment logging.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::FIS::ExperimentTemplate'
- actions
The actions for the experiment.
- attr_id
The ID of the experiment template.
- CloudformationAttribute:
Id
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
A description for the experiment template.
- log_configuration
The configuration for experiment logging.
- logical_id
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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The construct tree node associated with this construct.
- ref
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 })
.
- role_arn
The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- stop_conditions
The stop conditions.
- tags
The tags to apply to the experiment template.
- targets
The targets for the experiment.
Static Methods
- classmethod is_cfn_element(x)
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.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
CloudWatchLogsConfigurationProperty
- class CfnExperimentTemplate.CloudWatchLogsConfigurationProperty(*, log_group_arn)
Bases:
object
Specifies the configuration for experiment logging to CloudWatch Logs .
- Parameters:
log_group_arn (
str
) – The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis cloud_watch_logs_configuration_property = fis.CfnExperimentTemplate.CloudWatchLogsConfigurationProperty( log_group_arn="logGroupArn" )
Attributes
- log_group_arn
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
ExperimentTemplateActionProperty
- class CfnExperimentTemplate.ExperimentTemplateActionProperty(*, action_id, description=None, parameters=None, start_after=None, targets=None)
Bases:
object
Specifies an action for an experiment template.
For more information, see Actions in the AWS Fault Injection Simulator User Guide .
- Parameters:
action_id (
str
) – The ID of the action. The format of the action ID is: aws: service-name : action-type .description (
Optional
[str
]) – A description for the action.parameters (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The parameters for the action, if applicable.start_after (
Optional
[Sequence
[str
]]) – 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.targets (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The targets for the action.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis experiment_template_action_property = fis.CfnExperimentTemplate.ExperimentTemplateActionProperty( action_id="actionId", # the properties below are optional description="description", parameters={ "parameters_key": "parameters" }, start_after=["startAfter"], targets={ "targets_key": "targets" } )
Attributes
- action_id
The ID of the action.
The format of the action ID is: aws: service-name : action-type .
- description
A description for the action.
- parameters
The parameters for the action, if applicable.
- start_after
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.
ExperimentTemplateLogConfigurationProperty
- class CfnExperimentTemplate.ExperimentTemplateLogConfigurationProperty(*, log_schema_version, cloud_watch_logs_configuration=None, s3_configuration=None)
Bases:
object
Specifies the configuration for experiment logging.
For more information, see Experiment logging in the AWS Fault Injection Simulator User Guide .
- Parameters:
log_schema_version (
Union
[int
,float
]) – The schema version.cloud_watch_logs_configuration (
Optional
[Any
]) – The configuration for experiment logging to CloudWatch Logs .s3_configuration (
Optional
[Any
]) – The configuration for experiment logging to Amazon S3 .
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis # cloud_watch_logs_configuration: Any # s3_configuration: Any experiment_template_log_configuration_property = fis.CfnExperimentTemplate.ExperimentTemplateLogConfigurationProperty( log_schema_version=123, # the properties below are optional cloud_watch_logs_configuration=cloud_watch_logs_configuration, s3_configuration=s3_configuration )
Attributes
- cloud_watch_logs_configuration
The configuration for experiment logging to CloudWatch Logs .
- log_schema_version
The schema version.
- s3_configuration
The configuration for experiment logging to Amazon S3 .
ExperimentTemplateStopConditionProperty
- class CfnExperimentTemplate.ExperimentTemplateStopConditionProperty(*, source, value=None)
Bases:
object
Specifies a stop condition for an experiment template.
For more information, see Stop conditions in the AWS Fault Injection Simulator User Guide .
- Parameters:
source (
str
) – The source for the stop condition. Specifyaws:cloudwatch:alarm
if the stop condition is defined by a CloudWatch alarm. Specifynone
if there is no stop condition.value (
Optional
[str
]) – The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis experiment_template_stop_condition_property = fis.CfnExperimentTemplate.ExperimentTemplateStopConditionProperty( source="source", # the properties below are optional value="value" )
Attributes
- source
The source for the stop condition.
Specify
aws:cloudwatch:alarm
if the stop condition is defined by a CloudWatch alarm. Specifynone
if there is no stop condition.
- value
The Amazon Resource Name (ARN) of the CloudWatch alarm.
This is required if the source is a CloudWatch alarm.
ExperimentTemplateTargetFilterProperty
- class CfnExperimentTemplate.ExperimentTemplateTargetFilterProperty(*, path, values)
Bases:
object
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the AWS Fault Injection Simulator User Guide .
- Parameters:
path (
str
) – The attribute path for the filter.values (
Sequence
[str
]) – The attribute values for the filter.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis experiment_template_target_filter_property = fis.CfnExperimentTemplate.ExperimentTemplateTargetFilterProperty( path="path", values=["values"] )
Attributes
- path
The attribute path for the filter.
ExperimentTemplateTargetProperty
- class CfnExperimentTemplate.ExperimentTemplateTargetProperty(*, resource_type, selection_mode, filters=None, parameters=None, resource_arns=None, resource_tags=None)
Bases:
object
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 in the AWS Fault Injection Simulator User Guide .
- Parameters:
resource_type (
str
) – The resource type. The resource type must be supported for the specified action.selection_mode (
str
) – 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.filters (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ExperimentTemplateTargetFilterProperty
,Dict
[str
,Any
]]],None
]) – The filters to apply to identify target resources using specific attributes.parameters (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The parameters for the resource type.resource_arns (
Optional
[Sequence
[str
]]) – The Amazon Resource Names (ARNs) of the resources.resource_tags (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The tags for the target resources.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis experiment_template_target_property = fis.CfnExperimentTemplate.ExperimentTemplateTargetProperty( resource_type="resourceType", selection_mode="selectionMode", # the properties below are optional filters=[fis.CfnExperimentTemplate.ExperimentTemplateTargetFilterProperty( path="path", values=["values"] )], parameters={ "parameters_key": "parameters" }, resource_arns=["resourceArns"], resource_tags={ "resource_tags_key": "resourceTags" } )
Attributes
- filters
The filters to apply to identify target resources using specific attributes.
- parameters
The parameters for the resource type.
- resource_arns
The Amazon Resource Names (ARNs) of the resources.
- resource_tags
The tags for the target resources.
- resource_type
The resource type.
The resource type must be supported for the specified action.
- selection_mode
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.
S3ConfigurationProperty
- class CfnExperimentTemplate.S3ConfigurationProperty(*, bucket_name, prefix=None)
Bases:
object
Specifies the configuration for experiment logging to Amazon S3 .
- Parameters:
bucket_name (
str
) – The name of the destination bucket.prefix (
Optional
[str
]) – The bucket prefix.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_fis as fis s3_configuration_property = fis.CfnExperimentTemplate.S3ConfigurationProperty( bucket_name="bucketName", # the properties below are optional prefix="prefix" )
Attributes
- bucket_name
The name of the destination bucket.