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	aws.codepipeline.custom_action_types

Fields

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.
output_artifact_details	object	The details of the output artifact of 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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Category, InputArtifactDetails, OutputArtifactDetails, Provider, Version, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all custom_action_types in a region.

SELECT
region,
category,
configuration_properties,
input_artifact_details,
output_artifact_details,
provider,
settings,
tags,
version,
id
FROM aws.codepipeline.custom_action_types
WHERE region = 'us-east-1';

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 aws.codepipeline.custom_action_types
WHERE region = 'us-east-1' AND data__Identifier = '<Category>|<Provider>|<Version>';

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 aws.codepipeline.custom_action_types (
 Category,
 InputArtifactDetails,
 OutputArtifactDetails,
 Provider,
 Version,
 region
)
SELECT 
'{{ Category }}',
 '{{ InputArtifactDetails }}',
 '{{ OutputArtifactDetails }}',
 '{{ Provider }}',
 '{{ Version }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.codepipeline.custom_action_types (
 Category,
 ConfigurationProperties,
 InputArtifactDetails,
 OutputArtifactDetails,
 Provider,
 Settings,
 Tags,
 Version,
 region
)
SELECT 
 '{{ Category }}',
 '{{ ConfigurationProperties }}',
 '{{ InputArtifactDetails }}',
 '{{ OutputArtifactDetails }}',
 '{{ Provider }}',
 '{{ Settings }}',
 '{{ Tags }}',
 '{{ Version }}',
 '{{ region }}';

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: ConfigurationProperties
        value:
          - Description: '{{ Description }}'
            Key: '{{ Key }}'
            Name: '{{ Name }}'
            Queryable: '{{ Queryable }}'
            Required: '{{ Required }}'
            Secret: '{{ Secret }}'
            Type: '{{ Type }}'
      - name: InputArtifactDetails
        value:
          MaximumCount: '{{ MaximumCount }}'
          MinimumCount: '{{ MinimumCount }}'
      - name: OutputArtifactDetails
        value: null
      - name: Provider
        value: '{{ Provider }}'
      - name: Settings
        value:
          EntityUrlTemplate: '{{ EntityUrlTemplate }}'
          ExecutionUrlTemplate: '{{ ExecutionUrlTemplate }}'
          RevisionUrlTemplate: '{{ RevisionUrlTemplate }}'
          ThirdPartyConfigurationUrl: '{{ ThirdPartyConfigurationUrl }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: Version
        value: '{{ Version }}'

DELETE example

/*+ delete */
DELETE FROM aws.codepipeline.custom_action_types
WHERE data__Identifier = '<Category|Provider|Version>'
AND region = 'us-east-1';

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