Class: Aws::SSM::Types::StartChangeRequestExecutionRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

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

{
  scheduled_time: Time.now,
  document_name: "DocumentARN", # required
  document_version: "DocumentVersion",
  parameters: {
    "AutomationParameterKey" => ["AutomationParameterValue"],
  },
  change_request_name: "ChangeRequestName",
  client_token: "IdempotencyToken",
  auto_approve: false,
  runbooks: [ # required
    {
      document_name: "DocumentARN", # required
      document_version: "DocumentVersion",
      parameters: {
        "AutomationParameterKey" => ["AutomationParameterValue"],
      },
      target_parameter_name: "AutomationParameterKey",
      targets: [
        {
          key: "TargetKey",
          values: ["TargetValue"],
        },
      ],
      target_maps: [
        {
          "TargetMapKey" => ["TargetMapValue"],
        },
      ],
      max_concurrency: "MaxConcurrency",
      max_errors: "MaxErrors",
      target_locations: [
        {
          accounts: ["Account"],
          regions: ["Region"],
          target_location_max_concurrency: "MaxConcurrency",
          target_location_max_errors: "MaxErrors",
          execution_role_name: "ExecutionRoleName",
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  scheduled_end_time: Time.now,
  change_details: "ChangeDetailsValue",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_approveBoolean

Indicates whether the change request can be approved automatically without the need for manual approvals.

If `AutoApprovable` is enabled in a change template, then setting `AutoApprove` to `true` in `StartChangeRequestExecution` creates a change request that bypasses approver review.

<note markdown=“1”> Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is `CLOSED`, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again `OPEN`.

</note>

Returns:

  • (Boolean)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#change_detailsString

User-provided details about the change. If no details are provided, content specified in the **Template information** section of the associated change template is added.

Returns:

  • (String)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#change_request_nameString

The name of the change request associated with the runbook workflow to be run.

Returns:

  • (String)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Returns:

  • (String)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#document_nameString

The name of the change template document to run during the runbook workflow.

Returns:

  • (String)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The version of the change template document to run during the runbook workflow.

Returns:

  • (String)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,Array<String>>

A key-value map of parameters that match the declared parameters in the change template document.

Returns:

  • (Hash<String,Array<String>>)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#runbooksArray<Types::Runbook>

Information about the Automation runbooks that are run during the runbook workflow.

<note markdown=“1”> The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

</note>

Returns:


19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_end_timeTime

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

Returns:

  • (Time)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_timeTime

The date and time specified in the change request to run the Automation runbooks.

<note markdown=“1”> The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

</note>

Returns:

  • (Time)

19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

  • `Key=Environment,Value=Production`

  • `Key=Region,Value=us-east-2`

Returns:


19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
# File 'lib/aws-sdk-ssm/types.rb', line 19426

class StartChangeRequestExecutionRequest < Struct.new(
  :scheduled_time,
  :document_name,
  :document_version,
  :parameters,
  :change_request_name,
  :client_token,
  :auto_approve,
  :runbooks,
  :tags,
  :scheduled_end_time,
  :change_details)
  SENSITIVE = []
  include Aws::Structure
end