Skip to content

README.md

Latest commit

 

History

History
142 lines (83 loc) · 4.45 KB

README.md

File metadata and controls

142 lines (83 loc) · 4.45 KB

Surnet::ParameterStore::Secret

Resource schema for creating and managing AWS Systems Manager Parameter Store Secrets with generated passwords

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "Surnet::ParameterStore::Secret",
    "Properties" : {
        "Name" : String,
        "Description" : String,
        "KeyId" : String,
        "Tier" : String,
        "PasswordOptions" : PasswordOptions,
        "PasswordInput" : String,
        "Tags" : [ Tag, ... ]
    }
}

YAML

Type: Surnet::ParameterStore::Secret
Properties:
    Name: String
    Description: String
    KeyId: String
    Tier: String
    PasswordOptions: PasswordOptions
    PasswordInput: String
    Tags: 
      - Tag

Properties

Name

The name of the parameter. Must be unique in the current account and region.

Required: Yes

Type: String

Minimum Length: 1

Maximum Length: 2048

Pattern: ^[a-zA-Z0-9_.-/]+$

Update requires: Replacement

Description

Information about the parameter that you want to add to the system.

Required: No

Type: String

Maximum Length: 1024

Update requires: No interruption

KeyId

The KMS key ID to use to encrypt the parameter. If not provided, AWS will use the default key.

Required: No

Type: String

Update requires: No interruption

Tier

Parameter Store parameter tier.

Required: No

Type: String

Allowed Values: Standard | Advanced

Update requires: No interruption

PasswordOptions

Options for password generation. Either PasswordInput or PasswordOptions can be specified.

Required: No

Type: PasswordOptions

Update requires: No interruption

PasswordInput

The password value. Either PasswordInput or PasswordOptions can be specified.

Required: No

Type: String

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: List of Tag

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Name.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the parameter.

Password

The password value. This is a read-only property populated after creation.