Class: Aws::FIS::Types::CreateExperimentTemplateRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb

Overview

Note:

When making an API call, you may pass CreateExperimentTemplateRequest data as a hash:

{
  client_token: "ClientToken", # required
  description: "ExperimentTemplateDescription", # required
  stop_conditions: [ # required
    {
      source: "StopConditionSource", # required
      value: "StopConditionValue",
    },
  ],
  targets: {
    "ExperimentTemplateTargetName" => {
      resource_type: "TargetResourceTypeId", # required
      resource_arns: ["ResourceArn"],
      resource_tags: {
        "TagKey" => "TagValue",
      },
      filters: [
        {
          path: "ExperimentTemplateTargetFilterPath", # required
          values: ["ExperimentTemplateTargetFilterValue"], # required
        },
      ],
      selection_mode: "ExperimentTemplateTargetSelectionMode", # required
      parameters: {
        "ExperimentTemplateTargetParameterName" => "ExperimentTemplateTargetParameterValue",
      },
    },
  },
  actions: { # required
    "ExperimentTemplateActionName" => {
      action_id: "ActionId", # required
      description: "ExperimentTemplateActionDescription",
      parameters: {
        "ExperimentTemplateActionParameterName" => "ExperimentTemplateActionParameter",
      },
      targets: {
        "ExperimentTemplateActionTargetName" => "ExperimentTemplateTargetName",
      },
      start_after: ["ExperimentTemplateActionStartAfter"],
    },
  },
  role_arn: "RoleArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  log_configuration: {
    cloud_watch_logs_configuration: {
      log_group_arn: "CloudWatchLogGroupArn", # required
    },
    s3_configuration: {
      bucket_name: "S3BucketName", # required
      prefix: "S3ObjectKey",
    },
    log_schema_version: 1, # required
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsHash<String,Types::CreateExperimentTemplateActionInput>

The actions for the experiment.



323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the experiment template.

Returns:

  • (String)


323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_configurationTypes::CreateExperimentTemplateLogConfigurationInput

The configuration for experiment logging.



323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#stop_conditionsArray<Types::CreateExperimentTemplateStopConditionInput>

The stop conditions.



323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags to apply to the experiment template.

Returns:

  • (Hash<String,String>)


323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#targetsHash<String,Types::CreateExperimentTemplateTargetInput>

The targets for the experiment.



323
324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/types.rb', line 323

class CreateExperimentTemplateRequest < Struct.new(
  :client_token,
  :description,
  :stop_conditions,
  :targets,
  :actions,
  :role_arn,
  :tags,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end