software.amazon.awscdk.services.codepipeline

Interface CfnCustomActionType.SettingsProperty

All Known Implementing Classes:

CfnCustomActionType.SettingsProperty.Jsii$Proxy

Enclosing class:

CfnCustomActionType

public static interface CfnCustomActionType.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.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCustomActionType.SettingsProperty.Builder	builder()
default java.lang.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 java.lang.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 java.lang.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 java.lang.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.

Method Detail

getEntityUrlTemplate

default java.lang.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.

getExecutionUrlTemplate

default java.lang.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.

getRevisionUrlTemplate

default java.lang.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.

getThirdPartyConfigurationUrl

default java.lang.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.

builder

static CfnCustomActionType.SettingsProperty.Builder builder()

Returns:

a CfnCustomActionType.SettingsProperty.Builder of CfnCustomActionType.SettingsProperty