Interface IParameter
An SSM Parameter reference.
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IParameter : IResource, IParameterRef, IConstruct, IDependable, IEnvironmentAwareSyntax (vb)
Public Interface IParameter Inherits IResource, IParameterRef, IConstruct, IDependable, IEnvironmentAwareSynopsis
Properties
| ParameterArn | The ARN of the SSM Parameter resource. |
| ParameterName | The name of the SSM Parameter resource. |
| ParameterType | The type of the SSM Parameter resource. |
Methods
| GrantRead(IGrantable) | Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter. |
| GrantWrite(IGrantable) | Grants write (PutParameter) permissions on the SSM Parameter. |
Properties
ParameterArn
The ARN of the SSM Parameter resource.
string ParameterArn { get; }Property Value
Remarks
Attribute: true
ParameterName
The name of the SSM Parameter resource.
string ParameterName { get; }Property Value
Remarks
Attribute: true
ParameterType
The type of the SSM Parameter resource.
string ParameterType { get; }Property Value
Remarks
Attribute: true
Methods
GrantRead(IGrantable)
Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
Grant GrantRead(IGrantable grantee)Parameters
- grantee IGrantable
the role to be granted read-only access to the parameter.
Returns
GrantWrite(IGrantable)
Grants write (PutParameter) permissions on the SSM Parameter.
Grant GrantWrite(IGrantable grantee)Parameters
- grantee IGrantable
the role to be granted write access to the parameter.