Class CfnCustomActionType
A CloudFormation AWS::CodePipeline::CustomActionType
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public class CfnCustomActionType : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCustomActionType
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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. For more information, see Create and Add a Custom Action in AWS CodePipeline in the AWS CodePipeline User Guide .
CloudformationResource: AWS::CodePipeline::CustomActionType
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;
var cfnCustomActionType = new CfnCustomActionType(this, "MyCfnCustomActionType", new CfnCustomActionTypeProps {
Category = "category",
InputArtifactDetails = new ArtifactDetailsProperty {
MaximumCount = 123,
MinimumCount = 123
},
OutputArtifactDetails = new ArtifactDetailsProperty {
MaximumCount = 123,
MinimumCount = 123
},
Provider = "provider",
Version = "version",
// the properties below are optional
ConfigurationProperties = new [] { new ConfigurationPropertiesProperty {
Key = false,
Name = "name",
Required = false,
Secret = false,
// the properties below are optional
Description = "description",
Queryable = false,
Type = "type"
} },
Settings = new SettingsProperty {
EntityUrlTemplate = "entityUrlTemplate",
ExecutionUrlTemplate = "executionUrlTemplate",
RevisionUrlTemplate = "revisionUrlTemplate",
ThirdPartyConfigurationUrl = "thirdPartyConfigurationUrl"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCustomActionType(Construct, String, ICfnCustomActionTypeProps) | Create a new |
CfnCustomActionType(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCustomActionType(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrId | |
Category | The category of the custom action, such as a build action or a test action. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConfigurationProperties | The configuration properties for the custom action. |
InputArtifactDetails | The details of the input artifact for the action, such as its commit ID. |
OutputArtifactDetails | The details of the output artifact of the action, such as its commit ID. |
Provider | The provider of the service used in the custom action, such as CodeDeploy. |
Settings | URLs that provide users information about this custom action. |
Tags | The tags for the custom action. |
Version | The version identifier of the custom action. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCustomActionType(Construct, String, ICfnCustomActionTypeProps)
Create a new AWS::CodePipeline::CustomActionType
.
public CfnCustomActionType(Construct scope, string id, ICfnCustomActionTypeProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCustomActionTypeProps
- resource properties.
CfnCustomActionType(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCustomActionType(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCustomActionType(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCustomActionType(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
Category
The category of the custom action, such as a build action or a test action.
public virtual string Category { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigurationProperties
The configuration properties for the custom action.
public virtual object ConfigurationProperties { get; set; }
Property Value
System.Object
Remarks
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 .
InputArtifactDetails
The details of the input artifact for the action, such as its commit ID.
public virtual object InputArtifactDetails { get; set; }
Property Value
System.Object
Remarks
OutputArtifactDetails
The details of the output artifact of the action, such as its commit ID.
public virtual object OutputArtifactDetails { get; set; }
Property Value
System.Object
Remarks
Provider
The provider of the service used in the custom action, such as CodeDeploy.
public virtual string Provider { get; set; }
Property Value
System.String
Remarks
Settings
URLs that provide users information about this custom action.
public virtual object Settings { get; set; }
Property Value
System.Object
Remarks
Tags
The tags for the custom action.
public virtual TagManager Tags { get; }
Property Value
Remarks
Version
The version identifier of the custom action.
public virtual string Version { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>