Interface ICustomActionProperty
The creation attributes used for defining a configuration property of a custom Action.
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public interface ICustomActionProperty
Syntax (vb)
Public Interface ICustomActionProperty
Remarks
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 customActionProperty = new CustomActionProperty {
Name = "name",
Required = false,
// the properties below are optional
Description = "description",
Key = false,
Queryable = false,
Secret = false,
Type = "type"
};
Synopsis
Properties
Description | The description of the property. |
Key | Whether this property is a key. |
Name | The name of the property. |
Queryable | Whether this property is queryable. |
Required | Whether this property is required. |
Secret | Whether this property is secret, like a password, or access key. |
Type | The type of the property, like 'String', 'Number', or 'Boolean'. |
Properties
Description
The description of the property.
virtual string Description { get; }
Property Value
System.String
Remarks
Default: the description will be empty
Key
Whether this property is a key.
virtual Nullable<bool> Key { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Name
The name of the property.
string Name { get; }
Property Value
System.String
Remarks
You use this name in the configuration
attribute when defining your custom Action class.
Queryable
Whether this property is queryable.
virtual Nullable<bool> Queryable { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Note that only a single property of a custom Action can be queryable.
Default: false
Required
Whether this property is required.
bool Required { get; }
Property Value
System.Boolean
Secret
Whether this property is secret, like a password, or access key.
virtual Nullable<bool> Secret { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Type
The type of the property, like 'String', 'Number', or 'Boolean'.
virtual string Type { get; }
Property Value
System.String
Remarks
Default: 'String'