Class: Aws::SSM::Types::StartChangeRequestExecutionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::StartChangeRequestExecutionRequest
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#auto_approve ⇒ Boolean
Indicates whether the change request can be approved automatically without the need for manual approvals.
-
#change_details ⇒ String
User-provided details about the change.
-
#change_request_name ⇒ String
The name of the change request associated with the runbook workflow to be run.
-
#client_token ⇒ String
The user-provided idempotency token.
-
#document_name ⇒ String
The name of the change template document to run during the runbook workflow.
-
#document_version ⇒ String
The version of the change template document to run during the runbook workflow.
-
#parameters ⇒ Hash<String,Array<String>>
A key-value map of parameters that match the declared parameters in the change template document.
-
#runbooks ⇒ Array<Types::Runbook>
Information about the Automation runbooks that are run during the runbook workflow.
-
#scheduled_end_time ⇒ Time
The time that the requester expects the runbook workflow related to the change request to complete.
-
#scheduled_time ⇒ Time
The date and time specified in the change request to run the Automation runbooks.
-
#tags ⇒ Array<Types::Tag>
Optional metadata that you assign to a resource.
Instance Attribute Details
#auto_approve ⇒ Boolean
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.
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
.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_details ⇒ String
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.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_name ⇒ String
The name of the change request associated with the runbook workflow to be run.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_token ⇒ String
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_name ⇒ String
The name of the change template document to run during the runbook workflow.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_version ⇒ String
The version of the change template document to run during the runbook workflow.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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 |
#parameters ⇒ Hash<String,Array<String>>
A key-value map of parameters that match the declared parameters in the change template document.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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 |
#runbooks ⇒ Array<Types::Runbook>
Information about the Automation runbooks that are run during the runbook workflow.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_time ⇒ Time
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.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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_time ⇒ Time
The date and time specified in the change request to run the Automation runbooks.
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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 |
#tags ⇒ Array<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
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17310 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 |