Package software.amazon.awscdk

Class CfnOutput.Builder

java.lang.Object
software.amazon.awscdk.CfnOutput.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnOutput>
Enclosing class:
CfnOutput
@Stability(Stable) public static final class CfnOutput.Builder extends Object implements software.amazon.jsii.Builder<CfnOutput>
A fluent builder for CfnOutput.

  • Method Details

    • create

      @Stability(Stable) public static CfnOutput.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - The parent construct. This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of CfnOutput.Builder.

    • value

      @Stability(Stable) public CfnOutput.Builder value(String value)
      The value of the property returned by the aws cloudformation describe-stacks command.

      The value of an output can include literals, parameter references, pseudo-parameters, a mapping value, or intrinsic functions.

      Parameters:
      value - The value of the property returned by the aws cloudformation describe-stacks command. This parameter is required.
      Returns:
      this

    • condition

      @Stability(Stable) public CfnOutput.Builder condition(CfnCondition condition)
      A condition to associate with this output value.

      If the condition evaluates to false, this output value will not be included in the stack.

      Default: - No condition is associated with the output.

      Parameters:
      condition - A condition to associate with this output value. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnOutput.Builder description(String description)
      A String type that describes the output value.

      The description can be a maximum of 4 K in length.

      Default: - No description.

      Parameters:
      description - A String type that describes the output value. This parameter is required.
      Returns:
      this

    • exportName

      @Stability(Stable) public CfnOutput.Builder exportName(String exportName)
      The name used to export the value of this output across stacks.

      To import the value from another stack, use Fn.importValue(exportName).

      Default: - the output is not exported

      Parameters:
      exportName - The name used to export the value of this output across stacks. This parameter is required.
      Returns:
      this

    • key

      @Stability(Stable) public CfnOutput.Builder key(String key)
      The key of the property returned by aws cloudformation describe-stacks command.

      Parameters:
      key - The key of the property returned by aws cloudformation describe-stacks command. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnOutput build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnOutput>
      Returns:
      a newly built instance of CfnOutput.