interface SettingsProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CodePipeline.Mixins.CfnCustomActionTypePropsMixin.SettingsProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodepipeline/mixins#CfnCustomActionTypePropsMixin_SettingsProperty
Java	software.amazon.awscdk.mixins.preview.services.codepipeline.mixins.CfnCustomActionTypePropsMixin.SettingsProperty
Python	aws_cdk.mixins_preview.aws_codepipeline.mixins.CfnCustomActionTypePropsMixin.SettingsProperty
TypeScript	@aws-cdk/mixins-preview » aws_codepipeline » mixins » CfnCustomActionTypePropsMixin » SettingsProperty

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as codepipeline_mixins } from '@aws-cdk/mixins-preview/aws-codepipeline';
const settingsProperty: codepipeline_mixins.CfnCustomActionTypePropsMixin.SettingsProperty = {
  entityUrlTemplate: 'entityUrlTemplate',
  executionUrlTemplate: 'executionUrlTemplate',
  revisionUrlTemplate: 'revisionUrlTemplate',
  thirdPartyConfigurationUrl: 'thirdPartyConfigurationUrl',
};

Properties

Name	Type	Description
entityUrlTemplate?	string	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?	string	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?	string	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?	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?

Type: string (optional)

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.

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

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

---

executionUrlTemplate?

Type: string (optional)

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.

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate

---

revisionUrlTemplate?

Type: string (optional)

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.

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

---

thirdPartyConfigurationUrl?

Type: string (optional)

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.

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