Module: AWSCDK::SSM::IParameter

Includes:
IResource, Interfaces::AWSSSM::IParameterRef
Included in:
IStringListParameter, IStringParameter, StringListParameter, StringParameter
Defined in:
ssm/i_parameter.rb

Overview

An SSM Parameter reference.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'ssm/i_parameter.rb', line 115

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :parameter_ref => { kind: :property, name: "parameterRef", is_optional: false },
    :parameter_arn => { kind: :property, name: "parameterArn", is_optional: false },
    :parameter_name => { kind: :property, name: "parameterName", is_optional: false },
    :parameter_type => { kind: :property, name: "parameterType", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_write => { kind: :method, name: "grantWrite", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



92
93
94
95
 
# File 'ssm/i_parameter.rb', line 92

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'ssm/i_parameter.rb', line 27

def env()
  jsii_get_property("env")
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:

Returns:



101
102
103
104
 
# File 'ssm/i_parameter.rb', line 101

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_write(grantee) ⇒ AWSCDK::IAM::Grant

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:

Returns:



110
111
112
113
 
# File 'ssm/i_parameter.rb', line 110

def grant_write(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantWrite", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'ssm/i_parameter.rb', line 12

def node()
  jsii_get_property("node")
end

#parameter_arn ⇒ String

The ARN of the SSM Parameter resource.

Returns:

  • (String) 


48
49
50
 
# File 'ssm/i_parameter.rb', line 48

def parameter_arn()
  jsii_get_property("parameterArn")
end

#parameter_name ⇒ String

The name of the SSM Parameter resource.

Returns:

  • (String) 


55
56
57
 
# File 'ssm/i_parameter.rb', line 55

def parameter_name()
  jsii_get_property("parameterName")
end

#parameter_ref ⇒ AWSCDK::Interfaces::AWSSSM::ParameterReference

A reference to a Parameter resource.

Returns:



41
42
43
 
# File 'ssm/i_parameter.rb', line 41

def parameter_ref()
  jsii_get_property("parameterRef")
end

#parameter_type ⇒ String

The type of the SSM Parameter resource.

Returns:

  • (String) 


62
63
64
 
# File 'ssm/i_parameter.rb', line 62

def parameter_type()
  jsii_get_property("parameterType")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'ssm/i_parameter.rb', line 34

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



73
74
75
76
77
78
 
# File 'ssm/i_parameter.rb', line 73

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end