class Amazonite::Ssm::StartChangeRequestExecutionRequest

Included Modules

Defined in:

ssm/start_change_request_execution_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(document_name : String, runbooks : Array(Runbook), scheduled_time : Time | Nil = nil, document_version : String | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil, change_request_name : String | Nil = nil, client_token : String | Nil = nil, auto_approve : Bool | Nil = nil, tags : Array(Tag) | Nil = nil, scheduled_end_time : Time | Nil = nil, change_details : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def auto_approve : Bool | Nil #

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.

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.


[View source]
def auto_approve=(auto_approve : Bool | Nil) #

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.

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.


[View source]
def change_details : String | Nil #

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.


[View source]
def change_details=(change_details : String | Nil) #

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.


[View source]
def change_request_name : String | Nil #

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


[View source]
def change_request_name=(change_request_name : String | Nil) #

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


[View source]
def client_token : String | Nil #

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


[View source]
def client_token=(client_token : String | Nil) #

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


[View source]
def document_name : String #

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


[View source]
def document_name=(document_name : String) #

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


[View source]
def document_version : String | Nil #

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


[View source]
def document_version=(document_version : String | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def parameters : Hash(String, Array(String)) | Nil #

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


[View source]
def parameters=(parameters : Hash(String, Array(String)) | Nil) #

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


[View source]
def runbooks : Array(Runbook) #

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

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.


[View source]
def runbooks=(runbooks : Array(Runbook)) #

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

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.


[View source]
def scheduled_end_time : Time | Nil #

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.


[View source]
def scheduled_end_time=(scheduled_end_time : Time | Nil) #

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.


[View source]
def scheduled_time : Time | Nil #

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

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.


[View source]
def scheduled_time=(scheduled_time : Time | Nil) #

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

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.


[View source]
def tags : Array(Tag) | Nil #

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

The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.


[View source]
def tags=(tags : Array(Tag) | Nil) #

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

The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.


[View source]
def validate! : Nil #

[View source]