Package software.amazon.awscdk.services.codepipeline

Interface CfnCustomActionType.SettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomActionType.SettingsProperty.Jsii$Proxy

Enclosing class:

CfnCustomActionType

@Stability(Stable)
public static interface CfnCustomActionType.SettingsProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 SettingsProperty settingsProperty = SettingsProperty.builder()
         .entityUrlTemplate("entityUrlTemplate")
         .executionUrlTemplate("executionUrlTemplate")
         .revisionUrlTemplate("revisionUrlTemplate")
         .thirdPartyConfigurationUrl("thirdPartyConfigurationUrl")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCustomActionType.SettingsProperty.Builder	A builder for CfnCustomActionType.SettingsProperty
static final class	CfnCustomActionType.SettingsProperty.Jsii$Proxy	An implementation for CfnCustomActionType.SettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnCustomActionType.SettingsProperty.Builder	builder()
default String	getEntityUrlTemplate()	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.
default String	getExecutionUrlTemplate()	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.
default String	getRevisionUrlTemplate()	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.
default String	getThirdPartyConfigurationUrl()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityUrlTemplate

@Stability(Stable)
@Nullable
default String getEntityUrlTemplate()

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

getExecutionUrlTemplate

@Stability(Stable)
@Nullable
default String getExecutionUrlTemplate()

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

getRevisionUrlTemplate

@Stability(Stable)
@Nullable
default String getRevisionUrlTemplate()

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

getThirdPartyConfigurationUrl

@Stability(Stable)
@Nullable
default String getThirdPartyConfigurationUrl()

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

builder

@Stability(Stable)
static CfnCustomActionType.SettingsProperty.Builder builder()

Returns:

a CfnCustomActionType.SettingsProperty.Builder of CfnCustomActionType.SettingsProperty