Class: AWSCDK::APIGatewayv2::CfnAuthorizer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSApigatewayv2::IAuthorizerRef
Defined in:
api_gatewayv2/cfn_authorizer.rb

Overview

The AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API.

To learn more, see Controlling and managing access to a WebSocket API in API Gateway and Controlling and managing access to an HTTP API in API Gateway in the API Gateway Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAuthorizer

Create a new AWS::ApiGatewayV2::Authorizer.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::APIGatewayv2::CfnAuthorizerProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnAuthorizerProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkNmbkF1dGhvcml6ZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


182
183
184
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 182

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigatewayv2.CfnAuthorizer", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_authorizer(x) ⇒ Boolean

Checks whether the given object is a CfnAuthorizer.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


84
85
86
87
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 84

def self.is_cfn_authorizer(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.CfnAuthorizer", "isCfnAuthorizer", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_authorizer_id => { kind: :property, name: "attrAuthorizerId", is_optional: false },
    :authorizer_ref => { kind: :property, name: "authorizerRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :authorizer_type => { kind: :property, name: "authorizerType", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :authorizer_credentials_arn => { kind: :property, name: "authorizerCredentialsArn", is_optional: true },
    :authorizer_payload_format_version => { kind: :property, name: "authorizerPayloadFormatVersion", is_optional: true },
    :authorizer_result_ttl_in_seconds => { kind: :property, name: "authorizerResultTtlInSeconds", is_optional: true },
    :authorizer_uri => { kind: :property, name: "authorizerUri", is_optional: true },
    :enable_simple_responses => { kind: :property, name: "enableSimpleResponses", is_optional: true },
    :identity_source => { kind: :property, name: "identitySource", is_optional: true },
    :identity_validation_expression => { kind: :property, name: "identityValidationExpression", is_optional: true },
    :jwt_configuration => { kind: :property, name: "jwtConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



369
370
371
372
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 369

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



381
382
383
384
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 381

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



391
392
393
394
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 391

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



402
403
404
405
406
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 402

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


459
460
461
462
463
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 459

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



469
470
471
472
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 469

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



481
482
483
484
485
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 481

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#api_id ⇒ String

The API identifier.

Returns:

  • (String) 


203
204
205
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 203

def api_id()
  jsii_get_property("apiId")
end

#api_id=(value) ⇒ Object 



207
208
209
210
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 207

def api_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  jsii_set_property("apiId", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



494
495
496
497
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 494

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



516
517
518
519
520
521
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 516

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_authorizer_id ⇒ String

The authorizer ID.

Returns:

  • (String) 


189
190
191
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 189

def attr_authorizer_id()
  jsii_get_property("attrAuthorizerId")
end

#authorizer_credentials_arn ⇒ String?

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

Returns:

  • (String, nil) 


239
240
241
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 239

def authorizer_credentials_arn()
  jsii_get_property("authorizerCredentialsArn")
end

#authorizer_credentials_arn=(value) ⇒ Object 



243
244
245
246
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 243

def authorizer_credentials_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerCredentialsArn") unless value.nil?
  jsii_set_property("authorizerCredentialsArn", value)
end

#authorizer_payload_format_version ⇒ String?

Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Returns:

  • (String, nil) 


251
252
253
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 251

def authorizer_payload_format_version()
  jsii_get_property("authorizerPayloadFormatVersion")
end

#authorizer_payload_format_version=(value) ⇒ Object 



255
256
257
258
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 255

def authorizer_payload_format_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerPayloadFormatVersion") unless value.nil?
  jsii_set_property("authorizerPayloadFormatVersion", value)
end

#authorizer_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::AuthorizerReference

A reference to a Authorizer resource.

Returns:



196
197
198
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 196

def authorizer_ref()
  jsii_get_property("authorizerRef")
end

#authorizer_result_ttl_in_seconds ⇒ Numeric?

The time to live (TTL) for cached authorizer results, in seconds.

Returns:

  • (Numeric, nil) 


263
264
265
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 263

def authorizer_result_ttl_in_seconds()
  jsii_get_property("authorizerResultTtlInSeconds")
end

#authorizer_result_ttl_in_seconds=(value) ⇒ Object 



267
268
269
270
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 267

def authorizer_result_ttl_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "authorizerResultTtlInSeconds") unless value.nil?
  jsii_set_property("authorizerResultTtlInSeconds", value)
end

#authorizer_type ⇒ String

The authorizer type.

Returns:

  • (String) 


215
216
217
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 215

def authorizer_type()
  jsii_get_property("authorizerType")
end

#authorizer_type=(value) ⇒ Object 



219
220
221
222
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 219

def authorizer_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerType")
  jsii_set_property("authorizerType", value)
end

#authorizer_uri ⇒ String?

The authorizer's Uniform Resource Identifier (URI).

Returns:

  • (String, nil) 


275
276
277
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 275

def authorizer_uri()
  jsii_get_property("authorizerUri")
end

#authorizer_uri=(value) ⇒ Object 



279
280
281
282
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 279

def authorizer_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerUri") unless value.nil?
  jsii_set_property("authorizerUri", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



135
136
137
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 135

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


140
141
142
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 140

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


525
526
527
528
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 525

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


145
146
147
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 145

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


152
153
154
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 152

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


97
98
99
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 97

def creation_stack()
  jsii_get_property("creationStack")
end

#enable_simple_responses ⇒ Boolean, ...

Specifies whether a Lambda authorizer returns a response in a simple format.

Returns:



287
288
289
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 287

def enable_simple_responses()
  jsii_get_property("enableSimpleResponses")
end

#enable_simple_responses=(value) ⇒ Object 



291
292
293
294
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 291

def enable_simple_responses=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableSimpleResponses") unless value.nil?
  jsii_set_property("enableSimpleResponses", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



157
158
159
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 157

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



538
539
540
541
542
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 538

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



549
550
551
552
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 549

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#identity_source ⇒ Array<String>?

The identity source for which authorization is requested.

Returns:

  • (Array<String>, nil) 


299
300
301
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 299

def identity_source()
  jsii_get_property("identitySource")
end

#identity_source=(value) ⇒ Object 



303
304
305
306
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 303

def identity_source=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "identitySource") unless value.nil?
  jsii_set_property("identitySource", value)
end

#identity_validation_expression ⇒ String?

This parameter is not used.

Returns:

  • (String, nil) 


311
312
313
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 311

def identity_validation_expression()
  jsii_get_property("identityValidationExpression")
end

#identity_validation_expression=(value) ⇒ Object 



315
316
317
318
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 315

def identity_validation_expression=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityValidationExpression") unless value.nil?
  jsii_set_property("identityValidationExpression", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



619
620
621
622
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 619

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#jwt_configuration ⇒ AWSCDK::IResolvable, ...

The JWTConfiguration property specifies the configuration of a JWT authorizer.

Returns:



323
324
325
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 323

def jwt_configuration()
  jsii_get_property("jwtConfiguration")
end

#jwt_configuration=(value) ⇒ Object 



327
328
329
330
331
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 327

def jwt_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnAuthorizer::JWTConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuQ2ZuQXV0aG9yaXplci5KV1RDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "jwtConfiguration") unless value.nil?
  jsii_set_property("jwtConfiguration", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


109
110
111
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 109

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the authorizer.

Returns:

  • (String) 


227
228
229
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 227

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



231
232
233
234
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 231

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


92
93
94
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 92

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



560
561
562
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 560

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



567
568
569
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 567

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



360
361
362
363
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 360

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


128
129
130
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 128

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



578
579
580
581
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 578

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


585
586
587
588
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 585

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



595
596
597
598
599
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 595

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



604
605
606
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 604

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



118
119
120
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 118

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



336
337
338
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 336

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


165
166
167
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 165

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 175

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


610
611
612
613
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 610

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


349
350
351
352
353
354
 
# File 'api_gatewayv2/cfn_authorizer.rb', line 349

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