package awsssm

import (
	"github.com/aws/aws-cdk-go/awscdk/v2/awskms"
)

// Attributes for secure string parameters.
//
// Example:
//   parameterVersion := awscdk.Token_AsNumber(map[string]*string{
//   	"Ref": jsii.String("MyParameter"),
//   })
//
//   // Retrieve the latest value of the non-secret parameter
//   // with name "/My/String/Parameter".
//   stringValue := ssm.StringParameter_FromStringParameterAttributes(this, jsii.String("MyValue"), &StringParameterAttributes{
//   	ParameterName: jsii.String("/My/Public/Parameter"),
//   }).StringValue
//   stringValueVersionFromToken := ssm.StringParameter_FromStringParameterAttributes(this, jsii.String("MyValueVersionFromToken"), &StringParameterAttributes{
//   	ParameterName: jsii.String("/My/Public/Parameter"),
//   	// parameter version from token
//   	Version: parameterVersion,
//   }).StringValue
//
//   // Retrieve a specific version of the secret (SecureString) parameter.
//   // 'version' is always required.
//   secretValue := ssm.StringParameter_FromSecureStringParameterAttributes(this, jsii.String("MySecureValue"), &SecureStringParameterAttributes{
//   	ParameterName: jsii.String("/My/Secret/Parameter"),
//   	Version: jsii.Number(5),
//   })
//   secretValueVersionFromToken := ssm.StringParameter_FromSecureStringParameterAttributes(this, jsii.String("MySecureValueVersionFromToken"), &SecureStringParameterAttributes{
//   	ParameterName: jsii.String("/My/Secret/Parameter"),
//   	// parameter version from token
//   	Version: parameterVersion,
//   })
//
type SecureStringParameterAttributes struct {
	// 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).
	ParameterName *string `field:"required" json:"parameterName" yaml:"parameterName"`
	// Indicates of the parameter name is a simple name (i.e. does not include "/" separators).
	//
	// This is only 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.
	SimpleName *bool `field:"optional" json:"simpleName" yaml:"simpleName"`
	// The encryption key that is used to encrypt this parameter.
	EncryptionKey awskms.IKey `field:"optional" json:"encryptionKey" yaml:"encryptionKey"`
	// The version number of the value you wish to retrieve.
	Version *float64 `field:"optional" json:"version" yaml:"version"`
}