CfnExperimentTemplatePropsMixin
- class aws_cdk.mixins_preview.aws_fis.mixins.CfnExperimentTemplatePropsMixin(props, *, strategy=None)
Bases:
MixinSpecifies 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 Service User Guide .
- See:
- CloudformationResource:
AWS::FIS::ExperimentTemplate
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins # cloud_watch_logs_configuration: Any # s3_configuration: Any cfn_experiment_template_props_mixin = fis_mixins.CfnExperimentTemplatePropsMixin(fis_mixins.CfnExperimentTemplateMixinProps( actions={ "actions_key": fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateActionProperty( action_id="actionId", description="description", parameters={ "parameters_key": "parameters" }, start_after=["startAfter"], targets={ "targets_key": "targets" } ) }, description="description", experiment_options=fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateExperimentOptionsProperty( account_targeting="accountTargeting", empty_target_resolution_mode="emptyTargetResolutionMode" ), experiment_report_configuration=fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateExperimentReportConfigurationProperty( data_sources=fis_mixins.CfnExperimentTemplatePropsMixin.DataSourcesProperty( cloud_watch_dashboards=[fis_mixins.CfnExperimentTemplatePropsMixin.CloudWatchDashboardProperty( dashboard_identifier="dashboardIdentifier" )] ), outputs=fis_mixins.CfnExperimentTemplatePropsMixin.OutputsProperty( experiment_report_s3_configuration=fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentReportS3ConfigurationProperty( bucket_name="bucketName", prefix="prefix" ) ), post_experiment_duration="postExperimentDuration", pre_experiment_duration="preExperimentDuration" ), log_configuration=fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateLogConfigurationProperty( cloud_watch_logs_configuration=cloud_watch_logs_configuration, log_schema_version=123, s3_configuration=s3_configuration ), role_arn="roleArn", stop_conditions=[fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateStopConditionProperty( source="source", value="value" )], tags={ "tags_key": "tags" }, targets={ "targets_key": fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetProperty( filters=[fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetFilterProperty( path="path", values=["values"] )], parameters={ "parameters_key": "parameters" }, resource_arns=["resourceArns"], resource_tags={ "resource_tags_key": "resourceTags" }, resource_type="resourceType", selection_mode="selectionMode" ) } ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::FIS::ExperimentTemplate.- Parameters:
props (
Union[CfnExperimentTemplateMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['actions', 'description', 'experimentOptions', 'experimentReportConfiguration', 'logConfiguration', 'roleArn', 'stopConditions', 'tags', 'targets']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
CloudWatchDashboardProperty
- class CfnExperimentTemplatePropsMixin.CloudWatchDashboardProperty(*, dashboard_identifier=None)
Bases:
objectThe CloudWatch dashboards to include as data sources in the experiment report.
- Parameters:
dashboard_identifier (
Optional[str]) – The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins cloud_watch_dashboard_property = fis_mixins.CfnExperimentTemplatePropsMixin.CloudWatchDashboardProperty( dashboard_identifier="dashboardIdentifier" )
Attributes
- dashboard_identifier
The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
DataSourcesProperty
- class CfnExperimentTemplatePropsMixin.DataSourcesProperty(*, cloud_watch_dashboards=None)
Bases:
objectDescribes the data sources for the experiment report.
- Parameters:
cloud_watch_dashboards (
Union[IResolvable,Sequence[Union[IResolvable,CloudWatchDashboardProperty,Dict[str,Any]]],None]) – The CloudWatch dashboards to include as data sources in the experiment report.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins data_sources_property = fis_mixins.CfnExperimentTemplatePropsMixin.DataSourcesProperty( cloud_watch_dashboards=[fis_mixins.CfnExperimentTemplatePropsMixin.CloudWatchDashboardProperty( dashboard_identifier="dashboardIdentifier" )] )
Attributes
- cloud_watch_dashboards
The CloudWatch dashboards to include as data sources in the experiment report.
ExperimentReportS3ConfigurationProperty
- class CfnExperimentTemplatePropsMixin.ExperimentReportS3ConfigurationProperty(*, bucket_name=None, prefix=None)
Bases:
objectThe S3 destination for the experiment report.
- Parameters:
bucket_name (
Optional[str]) – The name of the S3 bucket where the experiment report will be stored.prefix (
Optional[str]) – The prefix of the S3 bucket where the experiment report will be stored.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_report_s3_configuration_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentReportS3ConfigurationProperty( bucket_name="bucketName", prefix="prefix" )
Attributes
- bucket_name
The name of the S3 bucket where the experiment report will be stored.
- prefix
The prefix of the S3 bucket where the experiment report will be stored.
ExperimentTemplateActionProperty
- class CfnExperimentTemplatePropsMixin.ExperimentTemplateActionProperty(*, action_id=None, description=None, parameters=None, start_after=None, targets=None)
Bases:
objectSpecifies an action for an experiment template.
For more information, see Actions in the AWS Fault Injection Service User Guide .
- Parameters:
action_id (
Optional[str]) – The ID of the action.description (
Optional[str]) – A description for the action.parameters (
Union[Mapping[str,str],IResolvable,None]) – The parameters for the action.start_after (
Optional[Sequence[str]]) – The name of the action that must be completed before the current action starts.targets (
Union[Mapping[str,str],IResolvable,None]) – The targets for the action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_template_action_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateActionProperty( action_id="actionId", description="description", parameters={ "parameters_key": "parameters" }, start_after=["startAfter"], targets={ "targets_key": "targets" } )
Attributes
- action_id
The ID of the action.
- description
A description for the action.
- parameters
The parameters for the action.
- start_after
The name of the action that must be completed before the current action starts.
ExperimentTemplateExperimentOptionsProperty
- class CfnExperimentTemplatePropsMixin.ExperimentTemplateExperimentOptionsProperty(*, account_targeting=None, empty_target_resolution_mode=None)
Bases:
objectDescribes the experiment options for an experiment template.
- Parameters:
account_targeting (
Optional[str]) – The account targeting setting for an experiment template.empty_target_resolution_mode (
Optional[str]) – The empty target resolution mode for an experiment template.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_template_experiment_options_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateExperimentOptionsProperty( account_targeting="accountTargeting", empty_target_resolution_mode="emptyTargetResolutionMode" )
Attributes
- account_targeting
The account targeting setting for an experiment template.
- empty_target_resolution_mode
The empty target resolution mode for an experiment template.
ExperimentTemplateExperimentReportConfigurationProperty
- class CfnExperimentTemplatePropsMixin.ExperimentTemplateExperimentReportConfigurationProperty(*, data_sources=None, outputs=None, post_experiment_duration=None, pre_experiment_duration=None)
Bases:
objectDescribes the report configuration for the experiment template.
- Parameters:
data_sources (
Union[IResolvable,DataSourcesProperty,Dict[str,Any],None]) – The data sources for the experiment report.outputs (
Union[IResolvable,OutputsProperty,Dict[str,Any],None]) – The output destinations of the experiment report.post_experiment_duration (
Optional[str]) – The duration after the experiment end time for the data sources to include in the report.pre_experiment_duration (
Optional[str]) – The duration before the experiment start time for the data sources to include in the report.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_template_experiment_report_configuration_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateExperimentReportConfigurationProperty( data_sources=fis_mixins.CfnExperimentTemplatePropsMixin.DataSourcesProperty( cloud_watch_dashboards=[fis_mixins.CfnExperimentTemplatePropsMixin.CloudWatchDashboardProperty( dashboard_identifier="dashboardIdentifier" )] ), outputs=fis_mixins.CfnExperimentTemplatePropsMixin.OutputsProperty( experiment_report_s3_configuration=fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentReportS3ConfigurationProperty( bucket_name="bucketName", prefix="prefix" ) ), post_experiment_duration="postExperimentDuration", pre_experiment_duration="preExperimentDuration" )
Attributes
- data_sources
The data sources for the experiment report.
- outputs
The output destinations of the experiment report.
- post_experiment_duration
The duration after the experiment end time for the data sources to include in the report.
- pre_experiment_duration
The duration before the experiment start time for the data sources to include in the report.
ExperimentTemplateLogConfigurationProperty
- class CfnExperimentTemplatePropsMixin.ExperimentTemplateLogConfigurationProperty(*, cloud_watch_logs_configuration=None, log_schema_version=None, s3_configuration=None)
Bases:
objectSpecifies the configuration for experiment logging.
For more information, see Experiment logging in the AWS Fault Injection Service User Guide .
- Parameters:
cloud_watch_logs_configuration (
Any) – The configuration for experiment logging to CloudWatch Logs .log_schema_version (
Union[int,float,None]) – The schema version.s3_configuration (
Any) – The configuration for experiment logging to Amazon S3 .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins # cloud_watch_logs_configuration: Any # s3_configuration: Any experiment_template_log_configuration_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateLogConfigurationProperty( cloud_watch_logs_configuration=cloud_watch_logs_configuration, log_schema_version=123, 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 CfnExperimentTemplatePropsMixin.ExperimentTemplateStopConditionProperty(*, source=None, value=None)
Bases:
objectSpecifies a stop condition for an experiment template.
For more information, see Stop conditions in the AWS Fault Injection Service User Guide .
- Parameters:
source (
Optional[str]) – The source for the stop condition.value (
Optional[str]) – The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_template_stop_condition_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateStopConditionProperty( source="source", value="value" )
Attributes
- source
The source for the stop condition.
- value
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
ExperimentTemplateTargetFilterProperty
- class CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetFilterProperty(*, path=None, values=None)
Bases:
objectSpecifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the AWS Fault Injection Service User Guide .
- Parameters:
path (
Optional[str]) – The attribute path for the filter.values (
Optional[Sequence[str]]) – The attribute values for the filter.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_template_target_filter_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetFilterProperty( path="path", values=["values"] )
Attributes
- path
The attribute path for the filter.
ExperimentTemplateTargetProperty
- class CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetProperty(*, filters=None, parameters=None, resource_arns=None, resource_tags=None, resource_type=None, selection_mode=None)
Bases:
objectSpecifies 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 Service User Guide .
- Parameters:
filters (
Union[IResolvable,Sequence[Union[IResolvable,ExperimentTemplateTargetFilterProperty,Dict[str,Any]]],None]) – The filters to apply to identify target resources using specific attributes.parameters (
Union[Mapping[str,str],IResolvable,None]) – The parameters for the resource type.resource_arns (
Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the targets.resource_tags (
Union[Mapping[str,str],IResolvable,None]) – The tags for the target resources.resource_type (
Optional[str]) – The resource type.selection_mode (
Optional[str]) – Scopes the identified resources to a specific count or percentage.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins experiment_template_target_property = fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetProperty( filters=[fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentTemplateTargetFilterProperty( path="path", values=["values"] )], parameters={ "parameters_key": "parameters" }, resource_arns=["resourceArns"], resource_tags={ "resource_tags_key": "resourceTags" }, resource_type="resourceType", selection_mode="selectionMode" )
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 targets.
- resource_tags
The tags for the target resources.
- resource_type
The resource type.
- selection_mode
Scopes the identified resources to a specific count or percentage.
OutputsProperty
- class CfnExperimentTemplatePropsMixin.OutputsProperty(*, experiment_report_s3_configuration=None)
Bases:
objectDescribes the output destinations of the experiment report.
- Parameters:
experiment_report_s3_configuration (
Union[IResolvable,ExperimentReportS3ConfigurationProperty,Dict[str,Any],None]) – The S3 destination for the experiment report.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fis import mixins as fis_mixins outputs_property = fis_mixins.CfnExperimentTemplatePropsMixin.OutputsProperty( experiment_report_s3_configuration=fis_mixins.CfnExperimentTemplatePropsMixin.ExperimentReportS3ConfigurationProperty( bucket_name="bucketName", prefix="prefix" ) )
Attributes
- experiment_report_s3_configuration
The S3 destination for the experiment report.