custom_action_types

Creates, updates, deletes or gets a custom_action_type resource or lists custom_action_types in a region

Overview

Name	custom_action_types
Type	Resource
Description	The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Id	awscc.codepipeline.custom_action_types

Fields

get (all properties)

Name	Datatype	Description
category	string	The category of the custom action, such as a build action or a test action.
▶configuration_properties	array	The configuration properties for the custom action.
▶input_artifact_details	object	The details of the input artifact for the action, such as its commit ID.
provider	string	The provider of the service used in the custom action, such as AWS CodeDeploy.
▶settings	object	URLs that provide users information about this custom action.
▶tags	array	Any tags assigned to the custom action.
version	string	The version identifier of the custom action.
id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
category	string	The category of the custom action, such as a build action or a test action.
provider	string	The provider of the service used in the custom action, such as AWS CodeDeploy.
version	string	The version identifier of the custom action.
id	string
region	string	AWS region.

For more information, see AWS::CodePipeline::CustomActionType.

Methods

Name	Resource	Accessible by	Required Params
create_resource	custom_action_types	INSERT	Category, InputArtifactDetails, OutputArtifactDetails, Provider, Version, region
delete_resource	custom_action_types	DELETE	Identifier, region
update_resource	custom_action_types	UPDATE	Identifier, PatchDocument, region
list_resources	custom_action_types_list_only	SELECT	region
get_resource	custom_action_types	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual custom_action_type.

SELECT
  region,
  category,
  configuration_properties,
  input_artifact_details,
  output_artifact_details,
  provider,
  settings,
  tags,
  version,
  id
FROM awscc.codepipeline.custom_action_types
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ category }}|{{ provider }}|{{ version }}';

list (identifiers only)

Lists all custom_action_types in a region.

SELECT
  region,
  category,
  provider,
  version
FROM awscc.codepipeline.custom_action_types_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new custom_action_type resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.codepipeline.custom_action_types (
  Category,
  InputArtifactDetails,
  OutputArtifactDetails,
  Provider,
  Version,
  region
)
SELECT
  '{{ category }}',
  '{{ input_artifact_details }}',
  '{{ output_artifact_details }}',
  '{{ provider }}',
  '{{ version }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.codepipeline.custom_action_types (
  Category,
  ConfigurationProperties,
  InputArtifactDetails,
  OutputArtifactDetails,
  Provider,
  Settings,
  Tags,
  Version,
  region
)
SELECT
  '{{ category }}',
  '{{ configuration_properties }}',
  '{{ input_artifact_details }}',
  '{{ output_artifact_details }}',
  '{{ provider }}',
  '{{ settings }}',
  '{{ tags }}',
  '{{ version }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: custom_action_type
  props:
    - name: category
      value: '{{ category }}'
    - name: configuration_properties
      value:
        - description: '{{ description }}'
          key: '{{ key }}'
          name: '{{ name }}'
          queryable: '{{ queryable }}'
          required: '{{ required }}'
          secret: '{{ secret }}'
          type: '{{ type }}'
    - name: input_artifact_details
      value:
        maximum_count: '{{ maximum_count }}'
        minimum_count: '{{ minimum_count }}'
    - name: output_artifact_details
      value: null
    - name: provider
      value: '{{ provider }}'
    - name: settings
      value:
        entity_url_template: '{{ entity_url_template }}'
        execution_url_template: '{{ execution_url_template }}'
        revision_url_template: '{{ revision_url_template }}'
        third_party_configuration_url: '{{ third_party_configuration_url }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: version
      value: '{{ version }}'

UPDATE example

Use the following StackQL query and manifest file to update a custom_action_type resource, using stack-deploy.

/*+ update */
UPDATE awscc.codepipeline.custom_action_types
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ category }}|{{ provider }}|{{ version }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.codepipeline.custom_action_types
WHERE
  Identifier = '{{ category }}|{{ provider }}|{{ version }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the custom_action_types resource, the following permissions are required:

Create

codepipeline:CreateCustomActionType,
codepipeline:TagResource,
codepipeline:ListActionTypes

Read

codepipeline:ListActionTypes,
codepipeline:ListTagsForResource

Update

codepipeline:ListActionTypes,
codepipeline:TagResource,
codepipeline:UntagResource

Delete

codepipeline:DeleteCustomActionType,
codepipeline:ListActionTypes

List

codepipeline:ListActionTypes