Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.VariableDeclarationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.VariableDeclarationProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.VariableDeclarationProperty
extends software.amazon.jsii.JsiiSerializable

A variable declared at the pipeline level.

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.*;
 VariableDeclarationProperty variableDeclarationProperty = VariableDeclarationProperty.builder()
         .name("name")
         // the properties below are optional
         .defaultValue("defaultValue")
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.VariableDeclarationProperty.Builder	builder()
default String	getDefaultValue()	The value of a pipeline-level variable.
default String	getDescription()	The description of a pipeline-level variable.
String	getName()	The name of a pipeline-level variable.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of a pipeline-level variable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-name

getDefaultValue

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

The value of a pipeline-level variable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-defaultvalue

getDescription

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

The description of a pipeline-level variable.

It's used to add additional context about the variable, and not being used at time when pipeline executes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-description

builder

@Stability(Stable)
static CfnPipeline.VariableDeclarationProperty.Builder builder()

Returns:

a CfnPipeline.VariableDeclarationProperty.Builder of CfnPipeline.VariableDeclarationProperty