Class: AWSCDK::APIGateway::APIKey

Inherits:
Resource
  • Object
show all
Includes:
IAPIKey
Defined in:
api_gateway/api_key.rb

Overview

An API Gateway ApiKey.

An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ APIKey

Returns a new instance of APIKey.

Parameters:



15
16
17
18
19
20
21
 
# File 'api_gateway/api_key.rb', line 15

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGateway::APIKeyProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5BcGlLZXlQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_api_key_id(scope, id, api_key_id) ⇒ AWSCDK::APIGateway::IAPIKey

Import an ApiKey by its Id.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • api_key_id (String)

Returns:



52
53
54
55
56
57
 
# File 'api_gateway/api_key.rb', line 52

def self.from_api_key_id(scope, id, api_key_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(api_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKeyId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.ApiKey", "fromApiKeyId", [scope, id, api_key_id])
end

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'api_gateway/api_key.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :api_key_ref => { kind: :property, name: "apiKeyRef", is_optional: false },
    :grants => { kind: :property, name: "grants", is_optional: false },
    :key_arn => { kind: :property, name: "keyArn", is_optional: false },
    :key_id => { kind: :property, name: "keyId", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_read_write => { kind: :method, name: "grantReadWrite", is_optional: false },
    :grant_write => { kind: :method, name: "grantWrite", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


105
106
107
 
# File 'api_gateway/api_key.rb', line 105

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ApiKey", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#api_key_ref ⇒ AWSCDK::Interfaces::AWSApigateway::APIKeyReference

A reference to a ApiKey resource.

Returns:



112
113
114
 
# File 'api_gateway/api_key.rb', line 112

def api_key_ref()
  jsii_get_property("apiKeyRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



170
171
172
173
 
# File 'api_gateway/api_key.rb', line 170

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#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:



187
188
189
190
 
# File 'api_gateway/api_key.rb', line 187

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:



77
78
79
 
# File 'api_gateway/api_key.rb', line 77

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


193
194
195
 
# File 'api_gateway/api_key.rb', line 193

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


207
208
209
210
211
212
 
# File 'api_gateway/api_key.rb', line 207

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


222
223
224
225
 
# File 'api_gateway/api_key.rb', line 222

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

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

Permits the IAM principal all read operations through this key.

The use of this method is discouraged. Please use grants.read() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



235
236
237
238
 
# File 'api_gateway/api_key.rb', line 235

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

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

Permits the IAM principal all read and write operations through this key.

The use of this method is discouraged. Please use grants.readWrite() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



248
249
250
251
 
# File 'api_gateway/api_key.rb', line 248

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

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

Permits the IAM principal all write operations through this key.

The use of this method is discouraged. Please use grants.write() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



261
262
263
264
 
# File 'api_gateway/api_key.rb', line 261

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

#grants ⇒ AWSCDK::APIGateway::APIKeyGrants

Collection of grant methods for an ApiKey.

Returns:



119
120
121
 
# File 'api_gateway/api_key.rb', line 119

def grants()
  jsii_get_property("grants")
end

#key_arn ⇒ String

The API key ARN.

Returns:

  • (String) 


126
127
128
 
# File 'api_gateway/api_key.rb', line 126

def key_arn()
  jsii_get_property("keyArn")
end

#key_id ⇒ String

The API key ID.

Returns:

  • (String) 


133
134
135
 
# File 'api_gateway/api_key.rb', line 133

def key_id()
  jsii_get_property("keyId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


62
63
64
 
# File 'api_gateway/api_key.rb', line 62

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


91
92
93
 
# File 'api_gateway/api_key.rb', line 91

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



98
99
100
 
# File 'api_gateway/api_key.rb', line 98

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


140
141
142
 
# File 'api_gateway/api_key.rb', line 140

def to_string()
  jsii_call_method("toString", [])
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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


153
154
155
156
157
158
 
# File 'api_gateway/api_key.rb', line 153

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