Param

Bases: DuploResourceV3

Commands

apply

Apply a Param

Create or Update a Param resource with Duplocloud cli.

CLI Usage

duploctl param apply -f 'param.yaml'

Contents of the param.yaml file

Returns:

Name	Type	Description
message	dict	Success message.

Parameters:

--file, -f, --cli-input

A file to read the input from

FileType('r') action: YamlAction

--patches, --add, --remove, --copy, --replace, --test, --move

The json patch to apply

str action: JsonPatchAction

create

Create an SSM Parameter Usage: cli usage

duploctl ssm_param create <name> -pval <value> -ptype <String|SecureString|StringList>

Returns:

Name	Type	Description
resource	dict	The SSM Parameter object.

Raises:

Type	Description
DuploError	If the SSM Parameter already exists.

Parameters:

name positional

The resource name

str

--file, -f, --cli-input

A file to read the input from

FileType('r') action: YamlAction

--parametertype, -ptype

The type of parameter to create

str default: String

String StringList SecureString

--parametervalue, -pval, -val, --value

Arbitrary text to add as the content of some secret or configuration paramater.

str

--dryrun, --dry-run

Do not submit any changes to the server, just print the data to the console.

bool

delete

Delete a Param resource by name.

cli usage

duploctl param delete <name>

Returns:

Name	Type	Description
message	dict	A success message.

Raises:

Type	Description
DuploError	If the {{kind}} resource could not be found or deleted.

Parameters:

name positional

The resource name

str

find

Find SSM Parameter resources by name and return it's content

cli usage

duploctl ssm_param find <name>

Returns:

Name	Type	Description
resource	dict	The SSM Parameter object.

Raises:

Type	Description
DuploError	If the SSM Parameter could not be found.

Parameters:

name positional

The resource name

str

--showsensitive, -show

Return sensitive values to output. WARNING - ENABLING THIS SETTING MAY DISPLAY SENSITIVE DATA TO STDOUT/LOG FILES

bool

list

Retrieve a List of Param resources

cli usage

duploctl param list

Returns:

Name	Type	Description
list	list	A list of Param.

update

Update an SSM Parameter. Usage: cli usage

duploctl ssm_param update <name> -pval <newvalue>

Returns:

Name	Type	Description
resource	dict	The SSM Parameter object.

Raises:

Type	Description
DuploError	If the SSM Parameter could not be found or doesn't exist.

Parameters:

name positional

The resource name

str

--strategy, -strat

The merge strategy to use. Valid options are "merge" or "replace". Default is merge.

str default: merge

merge replace

--parametervalue, -pval, -val, --value

Arbitrary text to add as the content of some secret or configuration paramater.

str

--dryrun, --dry-run

Do not submit any changes to the server, just print the data to the console.

bool

Methods

name_from_body