Package software.amazon.awscdk.services.ssm

Interface CfnParameterProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnParameterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.786Z") @Stability(Stable) public interface CfnParameterProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnParameter.

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.ssm.*;
 Object tags;
 CfnParameterProps cfnParameterProps = CfnParameterProps.builder()
         .type("type")
         .value("value")
         // the properties below are optional
         .allowedPattern("allowedPattern")
         .dataType("dataType")
         .description("description")
         .name("name")
         .policies("policies")
         .tags(tags)
         .tier("tier")
         .build();

  • Method Details

    • getType

      @Stability(Stable) @NotNull String getType()
      The type of parameter.

      AWS CloudFormation doesn't support creating a SecureString parameter type.

      Allowed Values : String | StringList

    • getValue

      @Stability(Stable) @NotNull String getValue()
      The parameter value.

      If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

    • getAllowedPattern

      @Stability(Stable) @Nullable default String getAllowedPattern()
      A regular expression used to validate the parameter value.

      For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

    • getDataType

      @Stability(Stable) @Nullable default String getDataType()
      The data type of the parameter, such as text or aws:ec2:image .

      The default is text .

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Information about the parameter.

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the parameter.

      The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

    • getPolicies

      @Stability(Stable) @Nullable default String getPolicies()
      Information about the policies assigned to a parameter.

      Assigning parameter policies in the AWS Systems Manager User Guide .

    • getTags

      @Stability(Stable) @Nullable default Object getTags()
      Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

      Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.

    • getTier

      @Stability(Stable) @Nullable default String getTier()
      The parameter tier.

    • builder

      @Stability(Stable) static CfnParameterProps.Builder builder()
      Returns:
      a CfnParameterProps.Builder of CfnParameterProps