io.cloudshiftdev.awscdk.services.ssm.SecureStringParameterAttributes.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.ssm
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.kms.IKey
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
/**
* Attributes for secure string parameters.
*
* Example:
*
* ```
* Number parameterVersion = Token.asNumber(Map.of("Ref", "MyParameter"));
* // Retrieve the latest value of the non-secret parameter
* // with name "/My/String/Parameter".
* String stringValue = StringParameter.fromStringParameterAttributes(this, "MyValue",
* StringParameterAttributes.builder()
* .parameterName("/My/Public/Parameter")
* .build()).getStringValue();
* String stringValueVersionFromToken = StringParameter.fromStringParameterAttributes(this,
* "MyValueVersionFromToken", StringParameterAttributes.builder()
* .parameterName("/My/Public/Parameter")
* // parameter version from token
* .version(parameterVersion)
* .build()).getStringValue();
* // Retrieve a specific version of the secret (SecureString) parameter.
* // 'version' is always required.
* IStringParameter secretValue = StringParameter.fromSecureStringParameterAttributes(this,
* "MySecureValue", SecureStringParameterAttributes.builder()
* .parameterName("/My/Secret/Parameter")
* .version(5)
* .build());
* IStringParameter secretValueVersionFromToken =
* StringParameter.fromSecureStringParameterAttributes(this, "MySecureValueVersionFromToken",
* SecureStringParameterAttributes.builder()
* .parameterName("/My/Secret/Parameter")
* // parameter version from token
* .version(parameterVersion)
* .build());
* ```
*/
public interface SecureStringParameterAttributes : CommonStringParameterAttributes {
/**
* The encryption key that is used to encrypt this parameter.
*
* Default: - default master key
*/
public fun encryptionKey(): IKey? = unwrap(this).getEncryptionKey()?.let(IKey::wrap)
/**
* The version number of the value you wish to retrieve.
*
* Default: - AWS CloudFormation uses the latest version of the parameter
*/
public fun version(): Number? = unwrap(this).getVersion()
/**
* A builder for [SecureStringParameterAttributes]
*/
@CdkDslMarker
public interface Builder {
/**
* @param encryptionKey The encryption key that is used to encrypt this parameter.
*/
public fun encryptionKey(encryptionKey: IKey)
/**
* @param parameterName 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).
*/
public fun parameterName(parameterName: String)
/**
* @param simpleName 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.
*/
public fun simpleName(simpleName: Boolean)
/**
* @param version The version number of the value you wish to retrieve.
*/
public fun version(version: Number)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.ssm.SecureStringParameterAttributes.Builder =
software.amazon.awscdk.services.ssm.SecureStringParameterAttributes.builder()
/**
* @param encryptionKey The encryption key that is used to encrypt this parameter.
*/
override fun encryptionKey(encryptionKey: IKey) {
cdkBuilder.encryptionKey(encryptionKey.let(IKey.Companion::unwrap))
}
/**
* @param parameterName 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).
*/
override fun parameterName(parameterName: String) {
cdkBuilder.parameterName(parameterName)
}
/**
* @param simpleName 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.
*/
override fun simpleName(simpleName: Boolean) {
cdkBuilder.simpleName(simpleName)
}
/**
* @param version The version number of the value you wish to retrieve.
*/
override fun version(version: Number) {
cdkBuilder.version(version)
}
public fun build(): software.amazon.awscdk.services.ssm.SecureStringParameterAttributes =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.ssm.SecureStringParameterAttributes,
) : CdkObject(cdkObject),
SecureStringParameterAttributes {
/**
* The encryption key that is used to encrypt this parameter.
*
* Default: - default master key
*/
override fun encryptionKey(): IKey? = unwrap(this).getEncryptionKey()?.let(IKey::wrap)
/**
* 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).
*/
override fun parameterName(): String = unwrap(this).getParameterName()
/**
* 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`
*/
override fun simpleName(): Boolean? = unwrap(this).getSimpleName()
/**
* The version number of the value you wish to retrieve.
*
* Default: - AWS CloudFormation uses the latest version of the parameter
*/
override fun version(): Number? = unwrap(this).getVersion()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): SecureStringParameterAttributes {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.ssm.SecureStringParameterAttributes):
SecureStringParameterAttributes = CdkObjectWrappers.wrap(cdkObject) as?
SecureStringParameterAttributes ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: SecureStringParameterAttributes):
software.amazon.awscdk.services.ssm.SecureStringParameterAttributes = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.ssm.SecureStringParameterAttributes
}
}