Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. codepipeline
  5. CustomActionType

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.codepipeline.CustomActionType

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    Create CustomActionType Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomActionType(name: string, args: CustomActionTypeArgs, opts?: CustomResourceOptions);
    @overload
def CustomActionType(resource_name: str,
                     args: CustomActionTypeArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def CustomActionType(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     category: Optional[str] = None,
                     input_artifact_details: Optional[CustomActionTypeArtifactDetailsArgs] = None,
                     output_artifact_details: Optional[CustomActionTypeArtifactDetailsArgs] = None,
                     provider: Optional[str] = None,
                     version: Optional[str] = None,
                     configuration_properties: Optional[Sequence[CustomActionTypeConfigurationPropertiesArgs]] = None,
                     settings: Optional[CustomActionTypeSettingsArgs] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCustomActionType(ctx *Context, name string, args CustomActionTypeArgs, opts ...ResourceOption) (*CustomActionType, error)
    public CustomActionType(string name, CustomActionTypeArgs args, CustomResourceOptions? opts = null)
    public CustomActionType(String name, CustomActionTypeArgs args)
public CustomActionType(String name, CustomActionTypeArgs args, CustomResourceOptions options)

    type: aws-native:codepipeline:CustomActionType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CustomActionTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomActionTypeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomActionTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomActionTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomActionTypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const customActionTypeResource = new aws_native.codepipeline.CustomActionType("customActionTypeResource", {
    category: "string",
    inputArtifactDetails: {
        maximumCount: 0,
        minimumCount: 0,
    },
    outputArtifactDetails: {
        maximumCount: 0,
        minimumCount: 0,
    },
    provider: "string",
    version: "string",
    configurationProperties: [{
        key: false,
        name: "string",
        required: false,
        secret: false,
        description: "string",
        queryable: false,
        type: "string",
    }],
    settings: {
        entityUrlTemplate: "string",
        executionUrlTemplate: "string",
        revisionUrlTemplate: "string",
        thirdPartyConfigurationUrl: "string",
    },
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    CustomActionType Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CustomActionType resource accepts the following input properties:

    Category string
    The category of the custom action, such as a build action or a test action.
    InputArtifactDetails Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeArtifactDetails
    The details of the input artifact for the action, such as its commit ID.
    OutputArtifactDetails Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeArtifactDetails
    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.
    Version string
    The version identifier of the custom action.
    ConfigurationProperties List<Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeConfigurationProperties>
    The configuration properties for the custom action.
    Settings Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeSettings
    URLs that provide users information about this custom action.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Any tags assigned to the custom action.
    Category string
    The category of the custom action, such as a build action or a test action.
    InputArtifactDetails CustomActionTypeArtifactDetailsArgs
    The details of the input artifact for the action, such as its commit ID.
    OutputArtifactDetails CustomActionTypeArtifactDetailsArgs
    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.
    Version string
    The version identifier of the custom action.
    ConfigurationProperties []CustomActionTypeConfigurationPropertiesArgs
    The configuration properties for the custom action.
    Settings CustomActionTypeSettingsArgs
    URLs that provide users information about this custom action.
    Tags TagArgs
    Any tags assigned to the custom action.
    category String
    The category of the custom action, such as a build action or a test action.
    inputArtifactDetails CustomActionTypeArtifactDetails
    The details of the input artifact for the action, such as its commit ID.
    outputArtifactDetails CustomActionTypeArtifactDetails
    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.
    version String
    The version identifier of the custom action.
    configurationProperties List<CustomActionTypeConfigurationProperties>
    The configuration properties for the custom action.
    settings CustomActionTypeSettings
    URLs that provide users information about this custom action.
    tags List<Tag>
    Any tags assigned to the custom action.
    category string
    The category of the custom action, such as a build action or a test action.
    inputArtifactDetails CustomActionTypeArtifactDetails
    The details of the input artifact for the action, such as its commit ID.
    outputArtifactDetails CustomActionTypeArtifactDetails
    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.
    version string
    The version identifier of the custom action.
    configurationProperties CustomActionTypeConfigurationProperties[]
    The configuration properties for the custom action.
    settings CustomActionTypeSettings
    URLs that provide users information about this custom action.
    tags Tag[]
    Any tags assigned to the custom action.
    category str
    The category of the custom action, such as a build action or a test action.
    input_artifact_details CustomActionTypeArtifactDetailsArgs
    The details of the input artifact for the action, such as its commit ID.
    output_artifact_details CustomActionTypeArtifactDetailsArgs
    The details of the output artifact of the action, such as its commit ID.
    provider str
    The provider of the service used in the custom action, such as AWS CodeDeploy.
    version str
    The version identifier of the custom action.
    configuration_properties Sequence[CustomActionTypeConfigurationPropertiesArgs]
    The configuration properties for the custom action.
    settings CustomActionTypeSettingsArgs
    URLs that provide users information about this custom action.
    tags Sequence[TagArgs]
    Any tags assigned to the custom action.
    category String
    The category of the custom action, such as a build action or a test action.
    inputArtifactDetails Property Map
    The details of the input artifact for the action, such as its commit ID.
    outputArtifactDetails Property Map
    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.
    version String
    The version identifier of the custom action.
    configurationProperties List<Property Map>
    The configuration properties for the custom action.
    settings Property Map
    URLs that provide users information about this custom action.
    tags List<Property Map>
    Any tags assigned to the custom action.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomActionType resource produces the following output properties:

    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CustomActionTypeArtifactDetails, CustomActionTypeArtifactDetailsArgs

    MaximumCount int
    The maximum number of artifacts allowed for the action type.
    MinimumCount int
    The minimum number of artifacts allowed for the action type.
    MaximumCount int
    The maximum number of artifacts allowed for the action type.
    MinimumCount int
    The minimum number of artifacts allowed for the action type.
    maximumCount Integer
    The maximum number of artifacts allowed for the action type.
    minimumCount Integer
    The minimum number of artifacts allowed for the action type.
    maximumCount number
    The maximum number of artifacts allowed for the action type.
    minimumCount number
    The minimum number of artifacts allowed for the action type.
    maximum_count int
    The maximum number of artifacts allowed for the action type.
    minimum_count int
    The minimum number of artifacts allowed for the action type.
    maximumCount Number
    The maximum number of artifacts allowed for the action type.
    minimumCount Number
    The minimum number of artifacts allowed for the action type.

    CustomActionTypeConfigurationProperties, CustomActionTypeConfigurationPropertiesArgs

    Key bool
    Whether the configuration property is a key.
    Name string
    The name of the action configuration property.
    Required bool
    Whether the configuration property is a required value.
    Secret bool
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    Description string
    The description of the action configuration property that is displayed to users.
    Queryable bool
    Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    Type string
    The type of the configuration property.
    Key bool
    Whether the configuration property is a key.
    Name string
    The name of the action configuration property.
    Required bool
    Whether the configuration property is a required value.
    Secret bool
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    Description string
    The description of the action configuration property that is displayed to users.
    Queryable bool
    Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    Type string
    The type of the configuration property.
    key Boolean
    Whether the configuration property is a key.
    name String
    The name of the action configuration property.
    required Boolean
    Whether the configuration property is a required value.
    secret Boolean
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    description String
    The description of the action configuration property that is displayed to users.
    queryable Boolean
    Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    type String
    The type of the configuration property.
    key boolean
    Whether the configuration property is a key.
    name string
    The name of the action configuration property.
    required boolean
    Whether the configuration property is a required value.
    secret boolean
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    description string
    The description of the action configuration property that is displayed to users.
    queryable boolean
    Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    type string
    The type of the configuration property.
    key bool
    Whether the configuration property is a key.
    name str
    The name of the action configuration property.
    required bool
    Whether the configuration property is a required value.
    secret bool
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    description str
    The description of the action configuration property that is displayed to users.
    queryable bool
    Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    type str
    The type of the configuration property.
    key Boolean
    Whether the configuration property is a key.
    name String
    The name of the action configuration property.
    required Boolean
    Whether the configuration property is a required value.
    secret Boolean
    Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
    description String
    The description of the action configuration property that is displayed to users.
    queryable Boolean
    Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    type String
    The type of the configuration property.

    CustomActionTypeSettings, CustomActionTypeSettingsArgs

    EntityUrlTemplate string
    The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
    ExecutionUrlTemplate string
    The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
    RevisionUrlTemplate string
    The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
    ThirdPartyConfigurationUrl string
    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
    EntityUrlTemplate string
    The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
    ExecutionUrlTemplate string
    The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
    RevisionUrlTemplate string
    The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
    ThirdPartyConfigurationUrl string
    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
    entityUrlTemplate String
    The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
    executionUrlTemplate String
    The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
    revisionUrlTemplate String
    The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
    thirdPartyConfigurationUrl String
    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
    entityUrlTemplate string
    The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
    executionUrlTemplate string
    The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
    revisionUrlTemplate string
    The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
    thirdPartyConfigurationUrl string
    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
    entity_url_template str
    The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
    execution_url_template str
    The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
    revision_url_template str
    The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
    third_party_configuration_url str
    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
    entityUrlTemplate String
    The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
    executionUrlTemplate String
    The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
    revisionUrlTemplate String
    The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
    thirdPartyConfigurationUrl String
    The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native