Class: Aws::CodePipeline::Types::ActionTypeDeclaration

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

Overview

Note:

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

{
  description: "ActionTypeDescription",
  executor: { # required
    configuration: { # required
      lambda_executor_configuration: {
        lambda_function_arn: "LambdaFunctionArn", # required
      },
      job_worker_executor_configuration: {
        polling_accounts: ["AccountId"],
        polling_service_principals: ["ServicePrincipal"],
      },
    },
    type: "JobWorker", # required, accepts JobWorker, Lambda
    policy_statements_template: "PolicyStatementsTemplate",
    job_timeout: 1,
  },
  id: { # required
    category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
    owner: "ActionTypeOwner", # required
    provider: "ActionProvider", # required
    version: "Version", # required
  },
  input_artifact_details: { # required
    minimum_count: 1, # required
    maximum_count: 1, # required
  },
  output_artifact_details: { # required
    minimum_count: 1, # required
    maximum_count: 1, # required
  },
  permissions: {
    allowed_accounts: ["AllowedAccount"], # required
  },
  properties: [
    {
      name: "ActionConfigurationKey", # required
      optional: false, # required
      key: false, # required
      no_echo: false, # required
      queryable: false,
      description: "PropertyDescription",
    },
  ],
  urls: {
    configuration_url: "Url",
    entity_url_template: "UrlTemplate",
    execution_url_template: "UrlTemplate",
    revision_url_template: "UrlTemplate",
  },
}

The parameters for the action type definition that are provided when the action type is created or updated.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description for the action type to be updated.

Returns:

  • (String) 


860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#executor ⇒ Types::ActionTypeExecutor

Information about the executor for an action type that was created with any supported integration model.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ Types::ActionTypeIdentifier

The action category, owner, provider, and version of the action type to be updated.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#input_artifact_details ⇒ Types::ActionTypeArtifactDetails

Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#output_artifact_details ⇒ Types::ActionTypeArtifactDetails

Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#permissions ⇒ Types::ActionTypePermissions

Details identifying the accounts with permissions to use the action type.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#properties ⇒ Array<Types::ActionTypeProperty>

The properties of the action type to be updated.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end

#urls ⇒ Types::ActionTypeUrls

The links associated with the action type to be updated.

Returns:



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 860

class ActionTypeDeclaration < Struct.new(
  :description,
  :executor,
  :id,
  :input_artifact_details,
  :output_artifact_details,
  :permissions,
  :properties,
  :urls)
  SENSITIVE = []
  include Aws::Structure
end