Param

Bases: DuploTenantResourceV3

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

Parameters:

Name	Type	Description	Default
body	BODY	The resource to apply.	required
wait	WAIT	Wait for the resource to be created.	False
patches	PATCHES	The patches to apply to the resource.	None

Returns:

Name	Type	Description
message	dict	Success message.

create

Create an SSM Parameter Usage: cli usage

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

Parameters:

Name	Type	Description	Default
name	NAME	The name of the SSM Parameter to create.	None
-ptype/--parametertype		The type of parameter to create, must be String, SecureString, or StringList	required
-pval/--parametervalue		Arbitrary text to set in the parameter. StringList expects comma separated values.	required
-body		path to a raw json/yaml post body, e.g:	required

Returns:

Name	Type	Description
resource	dict	The SSM Parameter object.

Raises:

Type	Description
DuploError	If the SSM Parameter already exists.

delete

Delete a Param resource by name.

cli usage

duploctl param delete <name>

Parameters:

Name	Type	Description	Default
name	NAME	The name of the Param resource to delete.	required

Returns:

Name	Type	Description
message	dict	A success message.

Raises:

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

find

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

cli usage

duploctl ssm_param find <name>

Parameters:

Name	Type	Description	Default
name	NAME	The name of the SSM Parameter to find.	required
-show/--showsensitive		Display value of SecureString parameters	required

Returns:

Name	Type	Description
resource	dict	The SSM Parameter object.

Raises:

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

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>

Parameters:

Name	Type	Description	Default
name	NAME	The name of the SSM Parameter to find.	None
-strat/--strategy		whether to merge or overwrite StringList Parameters (default is merge, not used for SecureString or String params)	required
-pval/--parametervalue		The new value for the SSM Parameter. Overwrites existing unless merging with StringList parameters.	required

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.