Class: Aws::ServiceCatalog::Types::CreateServiceActionInput

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

Overview

Note:

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

{
  name: "ServiceActionName", # required
  definition_type: "SSM_AUTOMATION", # required, accepts SSM_AUTOMATION
  definition: { # required
    "Name" => "ServiceActionDefinitionValue",
  },
  description: "ServiceActionDescription",
  accept_language: "AcceptLanguage",
  idempotency_token: "IdempotencyToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Returns:

  • (String)


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 1460

class CreateServiceActionInput < Struct.new(
  :name,
  :definition_type,
  :definition,
  :description,
  :accept_language,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#definitionHash<String,String>

The self-service action definition. Can be one of the following:

Name

The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

If you are using a shared SSM document, you must provide the ARN instead of the name.

Version

The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

AssumeRole

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

Parameters

The list of parameters in JSON format.

For example: [\{"Name":"InstanceId","Type":"TARGET"\}] or [\{"Name":"InstanceId","Type":"TEXT_VALUE"\}].

Returns:

  • (Hash<String,String>)


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 1460

class CreateServiceActionInput < Struct.new(
  :name,
  :definition_type,
  :definition,
  :description,
  :accept_language,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#definition_typeString

The service action definition type. For example, SSM_AUTOMATION.

Returns:

  • (String)


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 1460

class CreateServiceActionInput < Struct.new(
  :name,
  :definition_type,
  :definition,
  :description,
  :accept_language,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The self-service action description.

Returns:

  • (String)


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 1460

class CreateServiceActionInput < Struct.new(
  :name,
  :definition_type,
  :definition,
  :description,
  :accept_language,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_tokenString

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

  • (String)


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 1460

class CreateServiceActionInput < Struct.new(
  :name,
  :definition_type,
  :definition,
  :description,
  :accept_language,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The self-service action name.

Returns:

  • (String)


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 1460

class CreateServiceActionInput < Struct.new(
  :name,
  :definition_type,
  :definition,
  :description,
  :accept_language,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end