Class: Aws::AppConfig::Types::Action

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

Overview

Note:

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

{
  name: "Name",
  description: "Description",
  uri: "Uri",
  role_arn: "Arn",
}

An action defines the tasks the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT. Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:

  • PRE_CREATE_HOSTED_CONFIGURATION_VERSION

  • PRE_START_DEPLOYMENT

  • ON_DEPLOYMENT_START

  • ON_DEPLOYMENT_STEP

  • ON_DEPLOYMENT_BAKING

  • ON_DEPLOYMENT_COMPLETE

  • ON_DEPLOYMENT_ROLLED_BACK

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Information about the action.

Returns:

  • (String)


69
70
71
72
73
74
75
76
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 69

class Action < Struct.new(
  :name,
  :description,
  :uri,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The action name.

Returns:

  • (String)


69
70
71
72
73
74
75
76
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 69

class Action < Struct.new(
  :name,
  :description,
  :uri,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

Returns:

  • (String)


69
70
71
72
73
74
75
76
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 69

class Action < Struct.new(
  :name,
  :description,
  :uri,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#uriString

The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

Returns:

  • (String)


69
70
71
72
73
74
75
76
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 69

class Action < Struct.new(
  :name,
  :description,
  :uri,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end