Interface CfnCustomActionTypePropsMixin.ISettingsProperty

Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.CodePipeline

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnCustomActionTypePropsMixin.ISettingsProperty

Syntax (vb)

Public Interface CfnCustomActionTypePropsMixin.ISettingsProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.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.CfnPropertyMixins.AWS.CodePipeline;

             var settingsProperty = new SettingsProperty {
                 EntityUrlTemplate = "entityUrlTemplate",
                 ExecutionUrlTemplate = "executionUrlTemplate",
                 RevisionUrlTemplate = "revisionUrlTemplate",
                 ThirdPartyConfigurationUrl = "thirdPartyConfigurationUrl"
             };

Synopsis

Properties

EntityUrlTemplate	The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group.
ExecutionUrlTemplate	The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy.
RevisionUrlTemplate	The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
ThirdPartyConfigurationUrl	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.

Properties

EntityUrlTemplate

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group.

string? EntityUrlTemplate { get; }

Property Value

string

Remarks

This link is provided as part of the action display in the pipeline.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate

ExecutionUrlTemplate

The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy.

string? ExecutionUrlTemplate { get; }

Property Value

string

Remarks

This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate

RevisionUrlTemplate

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

string? RevisionUrlTemplate { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate

ThirdPartyConfigurationUrl

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.

string? ThirdPartyConfigurationUrl { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl