Class StringListParameter
Creates a new StringList SSM Parameter.
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public class StringListParameter : Resource, IStringListParameter, IParameter, IResource, IConstruct, IDependable
Syntax (vb)
Public Class StringListParameter
Inherits Resource
Implements IStringListParameter, IParameter, IResource, IConstruct, IDependable
Remarks
Resource: AWS::SSM::Parameter
ExampleMetadata: lit=test/integ.parameter.lit.ts infused
Examples
// Create a new SSM Parameter holding a String
var param = new StringParameter(stack, "StringParameter", new StringParameterProps {
// description: 'Some user-friendly description',
// name: 'ParameterName',
StringValue = "Initial parameter value"
});
// Grant read access to some Role
param.GrantRead(role);
// Create a new SSM Parameter holding a StringList
var listParameter = new StringListParameter(stack, "StringListParameter", new StringListParameterProps {
// description: 'Some user-friendly description',
// name: 'ParameterName',
StringListValue = new [] { "Initial parameter value A", "Initial parameter value B" }
});
Synopsis
Constructors
StringListParameter(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
StringListParameter(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
StringListParameter(Construct, String, IStringListParameterProps) |
Properties
EncryptionKey | The encryption key that is used to encrypt this parameter. |
ParameterArn | The ARN of the SSM Parameter resource. |
ParameterName | The name of the SSM Parameter resource. |
ParameterType | The type of the SSM Parameter resource. |
StringListValue | The parameter value. |
Methods
FromStringListParameterName(Construct, String, String) | Imports an external parameter of type string list. |
GrantRead(IGrantable) | Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter. |
GrantWrite(IGrantable) | Grants write (PutParameter) permissions on the SSM Parameter. |
Constructors
StringListParameter(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected StringListParameter(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
StringListParameter(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected StringListParameter(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
StringListParameter(Construct, String, IStringListParameterProps)
public StringListParameter(Construct scope, string id, IStringListParameterProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IStringListParameterProps
Properties
EncryptionKey
The encryption key that is used to encrypt this parameter.
public virtual IKey EncryptionKey { get; }
Property Value
Remarks
ParameterArn
The ARN of the SSM Parameter resource.
public virtual string ParameterArn { get; }
Property Value
System.String
ParameterName
The name of the SSM Parameter resource.
public virtual string ParameterName { get; }
Property Value
System.String
ParameterType
The type of the SSM Parameter resource.
public virtual string ParameterType { get; }
Property Value
System.String
StringListValue
The parameter value.
public virtual string[] StringListValue { get; }
Property Value
System.String[]
Remarks
Value must not nest another parameter. Do not use {{}} in the value. Values in the array
cannot contain commas (,
).
Methods
FromStringListParameterName(Construct, String, String)
Imports an external parameter of type string list.
public static IStringListParameter FromStringListParameterName(Construct scope, string id, string stringListParameterName)
Parameters
- scope Constructs.Construct
- id System.String
- stringListParameterName System.String
Returns
Remarks
Returns a token and should not be parsed.
GrantRead(IGrantable)
Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
public virtual Grant GrantRead(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
GrantWrite(IGrantable)
Grants write (PutParameter) permissions on the SSM Parameter.
public virtual Grant GrantWrite(IGrantable grantee)
Parameters
- grantee IGrantable
Returns