Interface CfnCustomActionType.IConfigurationPropertiesProperty

The configuration properties for the custom action.

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.AWS.CodePipeline.dll

Syntax (csharp)

public interface IConfigurationPropertiesProperty

Syntax (vb)

Public Interface IConfigurationPropertiesProperty

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html

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;

ConfigurationPropertiesProperty configurationPropertiesProperty = new ConfigurationPropertiesProperty {
    Key = false,
    Name = "name",
    Required = false,
    Secret = false,

    // the properties below are optional
    Description = "description",
    Queryable = false,
    Type = "type"
};

Synopsis

Properties

Description	The description of the action configuration property that is displayed to users.
Key	Whether the configuration property is a key.
Name	The name of the action configuration property.
Queryable	Indicates that the property is used with `PollForJobs` .
Required	Whether the configuration property is a required value.
Secret	Whether the configuration property is secret.
Type	The type of the configuration property.

Properties

Description

The description of the action configuration property that is displayed to users.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description

Key

Whether the configuration property is a key.

object Key { get; }

Property Value

System.Object

Remarks

Name

The name of the action configuration property.

string Name { get; }

Property Value

System.String

Remarks

Queryable

Indicates that the property is used with PollForJobs .

virtual object Queryable { get; }

Property Value

System.Object

Remarks

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.

Required

Whether the configuration property is a required value.

object Required { get; }

Property Value

System.Object

Remarks

Secret

Whether the configuration property is secret.

object Secret { get; }

Property Value

System.Object

Remarks

Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

Type

The type of the configuration property.

virtual string Type { get; }

Property Value

System.String