Package software.amazon.awscdk.services.appconfig

Class Parameter

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.appconfig.Parameter
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:02.346Z") @Stability(Stable) public class Parameter extends software.amazon.jsii.JsiiObject
Defines a parameter for an extension.

Example: 

 Function fn;
 Extension.Builder.create(this, "MyExtension")
         .actions(List.of(
             Action.Builder.create()
                     .actionPoints(List.of(ActionPoint.ON_DEPLOYMENT_START))
                     .eventDestination(new LambdaDestination(fn))
                     .build()))
         .parameters(List.of(Parameter.required("testParam", "true"), Parameter.notRequired("testNotRequiredParam")))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Parameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Parameter(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    The description of the parameter.
    Boolean
    getIsRequired()
    A boolean that indicates if the parameter is required or optional.
    String
    getName()
    The name of the parameter.
    String
    getValue()
    The value of the parameter.
    static Parameter
    notRequired(String name)
    An optional parameter for an extension.
    static Parameter
    notRequired(String name, String value)
    An optional parameter for an extension.
    static Parameter
    notRequired(String name, String value, String description)
    An optional parameter for an extension.
    static Parameter
    required(String name, String value)
    A required parameter for an extension.
    static Parameter
    required(String name, String value, String description)
    A required parameter for an extension.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Parameter

      protected Parameter(software.amazon.jsii.JsiiObjectRef objRef)

    • Parameter

      protected Parameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • notRequired

      @Stability(Stable) @NotNull public static Parameter notRequired(@NotNull String name, @Nullable String value, @Nullable String description)
      An optional parameter for an extension.

      Parameters:
      name - The name of the parameter. This parameter is required.
      value - The value of the parameter.
      description - A description for the parameter.

    • notRequired

      @Stability(Stable) @NotNull public static Parameter notRequired(@NotNull String name, @Nullable String value)
      An optional parameter for an extension.

      Parameters:
      name - The name of the parameter. This parameter is required.
      value - The value of the parameter.

    • notRequired

      @Stability(Stable) @NotNull public static Parameter notRequired(@NotNull String name)
      An optional parameter for an extension.

      Parameters:
      name - The name of the parameter. This parameter is required.

    • required

      @Stability(Stable) @NotNull public static Parameter required(@NotNull String name, @NotNull String value, @Nullable String description)
      A required parameter for an extension.

      Parameters:
      name - The name of the parameter. This parameter is required.
      value - The value of the parameter. This parameter is required.
      description - A description for the parameter.

    • required

      @Stability(Stable) @NotNull public static Parameter required(@NotNull String name, @NotNull String value)
      A required parameter for an extension.

      Parameters:
      name - The name of the parameter. This parameter is required.
      value - The value of the parameter. This parameter is required.

    • getIsRequired

      @Stability(Stable) @NotNull public Boolean getIsRequired()
      A boolean that indicates if the parameter is required or optional.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the parameter.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the parameter.

    • getValue

      @Stability(Stable) @Nullable public String getValue()
      The value of the parameter.