Package software.amazon.awscdk.services.ssm

Interface CommonStringParameterAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ListParameterAttributes, SecureStringParameterAttributes, StringParameterAttributes

All Known Implementing Classes:

CommonStringParameterAttributes.Jsii$Proxy, ListParameterAttributes.Jsii$Proxy, SecureStringParameterAttributes.Jsii$Proxy, StringParameterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:17.411Z")
@Stability(Stable)
public interface CommonStringParameterAttributes
extends software.amazon.jsii.JsiiSerializable

Common attributes for string parameters.

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.*;
 CommonStringParameterAttributes commonStringParameterAttributes = CommonStringParameterAttributes.builder()
         .parameterName("parameterName")
         // the properties below are optional
         .simpleName(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CommonStringParameterAttributes.Builder	builder()
String	getParameterName()	The name of the parameter store value.
default Boolean	getSimpleName()	Indicates whether the parameter name is a simple name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParameterName

@Stability(Stable)
@NotNull
String getParameterName()

The name of the parameter store value.

This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

getSimpleName

@Stability(Stable)
@Nullable
default Boolean getSimpleName()

Indicates whether the parameter name is a simple name.

A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN.

This is required only if parameterName is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs.

If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

Default: - auto-detect based on `parameterName`

builder

@Stability(Stable)
static CommonStringParameterAttributes.Builder builder()

Returns:

a CommonStringParameterAttributes.Builder of CommonStringParameterAttributes