You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::CreateCustomActionTypeInput

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 CreateCustomActionTypeInput data as a hash:

{
  category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
  provider: "ActionProvider", # required
  version: "Version", # required
  settings: {
    third_party_configuration_url: "Url",
    entity_url_template: "UrlTemplate",
    execution_url_template: "UrlTemplate",
    revision_url_template: "UrlTemplate",
  },
  configuration_properties: [
    {
      name: "ActionConfigurationKey", # required
      required: false, # required
      key: false, # required
      secret: false, # required
      queryable: false,
      description: "Description",
      type: "String", # accepts String, Number, Boolean
    },
  ],
  input_artifact_details: { # required
    minimum_count: 1, # required
    maximum_count: 1, # required
  },
  output_artifact_details: { # required
    minimum_count: 1, # required
    maximum_count: 1, # required
  },
}

Represents the input of a CreateCustomActionType operation.

Instance Attribute Summary collapse

Instance Attribute Details

#categoryString

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

Returns:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end

#configuration_propertiesArray<Types::ActionConfigurationProperty>

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name\}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.



858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end

#input_artifact_detailsTypes::ArtifactDetails

The details of the input artifact for the action, such as its commit ID.



858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end

#output_artifact_detailsTypes::ArtifactDetails

The details of the output artifact of the action, such as its commit ID.



858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end

#providerString

The provider of the service used in the custom action, such as AWS CodeDeploy.

Returns:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end

#settingsTypes::ActionTypeSettings

Returns information about the settings for an action type.



858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end

#versionString

The version identifier of the custom action.

Returns:

  • (String)


858
859
860
861
862
863
864
865
866
867
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 858

class CreateCustomActionTypeInput < Struct.new(
  :category,
  :provider,
  :version,
  :settings,
  :configuration_properties,
  :input_artifact_details,
  :output_artifact_details)
  include Aws::Structure
end