Method: Aws::Drs::Client#put_launch_action

Defined in:

lib/aws-sdk-drs/client.rb

#put_launch_action(params = {}) ⇒ Types::PutLaunchActionResponse

Puts a resource launch action.

Examples:

Request syntax with placeholder values

resp = client.put_launch_action({
  action_code: "SsmDocumentName", # required
  action_id: "LaunchActionId", # required
  action_version: "LaunchActionVersion", # required
  active: false, # required
  category: "MONITORING", # required, accepts MONITORING, VALIDATION, CONFIGURATION, SECURITY, OTHER
  description: "LaunchActionDescription", # required
  name: "LaunchActionName", # required
  optional: false, # required
  order: 1, # required
  parameters: {
    "LaunchActionParameterName" => {
      type: "SSM_STORE", # accepts SSM_STORE, DYNAMIC
      value: "LaunchActionParameterValue",
    },
  },
  resource_id: "LaunchActionResourceId", # required
})

Response structure

resp.action_code #=> String
resp.action_id #=> String
resp.action_version #=> String
resp.active #=> Boolean
resp.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.description #=> String
resp.name #=> String
resp.optional #=> Boolean
resp.order #=> Integer
resp.parameters #=> Hash
resp.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.parameters["LaunchActionParameterName"].value #=> String
resp.resource_id #=> String
resp.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :action_code (required, String) —

  Launch action code.

• :action_id (required, String) —

  Launch action Id.

• :action_version (required, String) —

  Launch action version.

• :active (required, Boolean) —

  Whether the launch action is active.

• :category (required, String) —

  Launch action category.

• :description (required, String) —

  Launch action description.

• :name (required, String) —

  Launch action name.

• :optional (required, Boolean) —

  Whether the launch will not be marked as failed if this action fails.

• :order (required, Integer) —

  Launch action order.

• :parameters (Hash<String,Types::LaunchActionParameter>) —

  Launch action parameters.

• :resource_id (required, String) —

  Launch configuration template Id or Source Server Id

Returns:

• (Types::PutLaunchActionResponse) —

  Returns a response object which responds to the following methods:

  • #action_code => String

  • #action_id => String

  • #action_version => String

  • #active => Boolean

  • #category => String

  • #description => String

  • #name => String

  • #optional => Boolean

  • #order => Integer

  • #parameters => Hash&lt;String,Types::LaunchActionParameter&gt;

  • #resource_id => String

  • #type => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-drs/client.rb', line 2254

def put_launch_action(params = {}, options = {})
  req = build_request(:put_launch_action, params)
  req.send_request(options)
end