Class: AWSCDK::BedrockAgentCore::GatewayBase
- Inherits:
-
Resource
- Object
- Resource
- AWSCDK::BedrockAgentCore::GatewayBase
- Includes:
- IGateway
- Defined in:
- bedrock_agent_core/gateway_base.rb
Overview
**************************************************************************** Base Class ***************************************************************************.
Direct Known Subclasses
Class Method Summary collapse
Instance Method Summary collapse
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Override the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy) ⇒ void
Apply the given removal policy to this resource.
-
#authorizer_configuration ⇒ AWSCDK::BedrockAgentCore::IGatewayAuthorizerConfig
The authorizer configuration for the gateway.
-
#created_at ⇒ String?
Timestamp when the gateway was created.
-
#description ⇒ String?
The description of the gateway.
-
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
The environment this resource belongs to.
-
#exception_level ⇒ AWSCDK::BedrockAgentCore::GatewayExceptionLevel?
The exception level for the gateway.
-
#gateway_arn ⇒ String
The ARN of the gateway resource.
-
#gateway_id ⇒ String
The id of the gateway.
-
#gateway_name ⇒ String
The name of the gateway.
-
#gateway_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayReference
A reference to a Gateway resource.
-
#gateway_url ⇒ String?
The URL endpoint for the gateway.
- #generate_physical_name ⇒ String
-
#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). -
#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). -
#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant
Grants IAM actions to the IAM Principal.
-
#grant_invoke(grantee) ⇒ AWSCDK::IAM::Grant
Grants permission to invoke this Gateway.
-
#grant_manage(grantee) ⇒ AWSCDK::IAM::Grant
Grants
Create,Update, andDeleteactions on the Gateway. -
#grant_read(grantee) ⇒ AWSCDK::IAM::Grant
Grants
GetandListactions on the Gateway. -
#initialize(scope, id, props = nil) ⇒ GatewayBase
constructor
A new instance of GatewayBase.
-
#kms_key ⇒ AWSCDK::KMS::IKey?
The KMS key used for encryption.
-
#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return the given named metric for this gateway.
-
#metric_duration(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric measuring the duration of requests for this gateway.
-
#metric_invocations(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the total number of invocations for this gateway.
-
#metric_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric measuring the latency of requests for this gateway.
-
#metric_system_errors(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of system errors (5xx status code) for this gateway.
-
#metric_target_execution_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric measuring the target execution time for this gateway.
-
#metric_target_type(target_type, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of requests served by each target type for this gateway.
-
#metric_throttles(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of throttled requests (429 status code) for this gateway.
-
#metric_user_errors(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.
-
#node ⇒ Constructs::Node
The tree node.
-
#physical_name ⇒ String
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
-
#protocol_configuration ⇒ AWSCDK::BedrockAgentCore::IGatewayProtocolConfig
The protocol configuration for the gateway.
-
#role ⇒ AWSCDK::IAM::IRole
The IAM role that provides permissions for the gateway to access AWS services.
-
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
-
#status ⇒ String?
The status of the gateway.
-
#status_reason ⇒ Array<String>?
The status reasons for the gateway.
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_at ⇒ String?
Timestamp when the gateway was last updated.
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props = nil) ⇒ GatewayBase
Returns a new instance of GatewayBase.
12 13 14 15 16 17 18 |
# File 'bedrock_agent_core/gateway_base.rb', line 12 def initialize(scope, id, props = nil) props = props.is_a?(Hash) ? ::AWSCDK::ResourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvdXJjZVByb3BzIn0=")), "props") unless props.nil? Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.jsii_overridable_methods ⇒ Object
20 21 22 23 24 25 26 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 |
# File 'bedrock_agent_core/gateway_base.rb', line 20 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 }, :authorizer_configuration => { kind: :property, name: "authorizerConfiguration", is_optional: false }, :gateway_arn => { kind: :property, name: "gatewayArn", is_optional: false }, :gateway_id => { kind: :property, name: "gatewayId", is_optional: false }, :gateway_name => { kind: :property, name: "gatewayName", is_optional: false }, :gateway_ref => { kind: :property, name: "gatewayRef", is_optional: false }, :protocol_configuration => { kind: :property, name: "protocolConfiguration", is_optional: false }, :role => { kind: :property, name: "role", is_optional: false }, :created_at => { kind: :property, name: "createdAt", is_optional: true }, :description => { kind: :property, name: "description", is_optional: true }, :exception_level => { kind: :property, name: "exceptionLevel", is_optional: true }, :gateway_url => { kind: :property, name: "gatewayUrl", is_optional: true }, :kms_key => { kind: :property, name: "kmsKey", is_optional: true }, :status => { kind: :property, name: "status", is_optional: true }, :status_reason => { kind: :property, name: "statusReason", is_optional: true }, :updated_at => { kind: :property, name: "updatedAt", is_optional: true }, :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 => { kind: :method, name: "grant", is_optional: false }, :grant_invoke => { kind: :method, name: "grantInvoke", is_optional: false }, :grant_manage => { kind: :method, name: "grantManage", is_optional: false }, :grant_read => { kind: :method, name: "grantRead", is_optional: false }, :metric => { kind: :method, name: "metric", is_optional: false }, :metric_duration => { kind: :method, name: "metricDuration", is_optional: false }, :metric_invocations => { kind: :method, name: "metricInvocations", is_optional: false }, :metric_latency => { kind: :method, name: "metricLatency", is_optional: false }, :metric_system_errors => { kind: :method, name: "metricSystemErrors", is_optional: false }, :metric_target_execution_time => { kind: :method, name: "metricTargetExecutionTime", is_optional: false }, :metric_target_type => { kind: :method, name: "metricTargetType", is_optional: false }, :metric_throttles => { kind: :method, name: "metricThrottles", is_optional: false }, :metric_user_errors => { kind: :method, name: "metricUserErrors", is_optional: false }, } end |
Instance Method Details
#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.
245 246 247 248 |
# File 'bedrock_agent_core/gateway_base.rb', line 245 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).
262 263 264 265 |
# File 'bedrock_agent_core/gateway_base.rb', line 262 def apply_removal_policy(policy) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") jsii_call_method("applyRemovalPolicy", [policy]) end |
#authorizer_configuration ⇒ AWSCDK::BedrockAgentCore::IGatewayAuthorizerConfig
The authorizer configuration for the gateway.
110 111 112 |
# File 'bedrock_agent_core/gateway_base.rb', line 110 def () jsii_get_property("authorizerConfiguration") end |
#created_at ⇒ String?
Timestamp when the gateway was created.
159 160 161 |
# File 'bedrock_agent_core/gateway_base.rb', line 159 def created_at() jsii_get_property("createdAt") end |
#description ⇒ String?
The description of the gateway.
166 167 168 |
# File 'bedrock_agent_core/gateway_base.rb', line 166 def description() jsii_get_property("description") 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.
82 83 84 |
# File 'bedrock_agent_core/gateway_base.rb', line 82 def env() jsii_get_property("env") end |
#exception_level ⇒ AWSCDK::BedrockAgentCore::GatewayExceptionLevel?
The exception level for the gateway.
173 174 175 |
# File 'bedrock_agent_core/gateway_base.rb', line 173 def exception_level() jsii_get_property("exceptionLevel") end |
#gateway_arn ⇒ String
The ARN of the gateway resource.
117 118 119 |
# File 'bedrock_agent_core/gateway_base.rb', line 117 def gateway_arn() jsii_get_property("gatewayArn") end |
#gateway_id ⇒ String
The id of the gateway.
124 125 126 |
# File 'bedrock_agent_core/gateway_base.rb', line 124 def gateway_id() jsii_get_property("gatewayId") end |
#gateway_name ⇒ String
The name of the gateway.
131 132 133 |
# File 'bedrock_agent_core/gateway_base.rb', line 131 def gateway_name() jsii_get_property("gatewayName") end |
#gateway_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayReference
A reference to a Gateway resource.
138 139 140 |
# File 'bedrock_agent_core/gateway_base.rb', line 138 def gateway_ref() jsii_get_property("gatewayRef") end |
#gateway_url ⇒ String?
The URL endpoint for the gateway.
180 181 182 |
# File 'bedrock_agent_core/gateway_base.rb', line 180 def gateway_url() jsii_get_property("gatewayUrl") end |
#generate_physical_name ⇒ String
268 269 270 |
# File 'bedrock_agent_core/gateway_base.rb', line 268 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.
282 283 284 285 286 287 |
# File 'bedrock_agent_core/gateway_base.rb', line 282 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.
297 298 299 300 |
# File 'bedrock_agent_core/gateway_base.rb', line 297 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(grantee, *actions) ⇒ AWSCDK::IAM::Grant
Grants IAM actions to the IAM Principal.
[disable-awslint:no-grants]
309 310 311 312 313 314 315 |
# File 'bedrock_agent_core/gateway_base.rb', line 309 def grant(grantee, *actions) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") actions.each_with_index do |item, index| Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]") end jsii_call_method("grant", [grantee, *actions]) end |
#grant_invoke(grantee) ⇒ AWSCDK::IAM::Grant
Grants permission to invoke this Gateway.
[disable-awslint:no-grants]
323 324 325 326 |
# File 'bedrock_agent_core/gateway_base.rb', line 323 def grant_invoke(grantee) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") jsii_call_method("grantInvoke", [grantee]) end |
#grant_manage(grantee) ⇒ AWSCDK::IAM::Grant
Grants Create, Update, and Delete actions on the Gateway.
[disable-awslint:no-grants]
334 335 336 337 |
# File 'bedrock_agent_core/gateway_base.rb', line 334 def grant_manage(grantee) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") jsii_call_method("grantManage", [grantee]) end |
#grant_read(grantee) ⇒ AWSCDK::IAM::Grant
Grants Get and List actions on the Gateway.
[disable-awslint:no-grants]
345 346 347 348 |
# File 'bedrock_agent_core/gateway_base.rb', line 345 def grant_read(grantee) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") jsii_call_method("grantRead", [grantee]) end |
#kms_key ⇒ AWSCDK::KMS::IKey?
The KMS key used for encryption.
187 188 189 |
# File 'bedrock_agent_core/gateway_base.rb', line 187 def kms_key() jsii_get_property("kmsKey") end |
#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return the given named metric for this gateway.
By default, the metric will be calculated as a sum over a period of 5 minutes.
You can customize this by using the statistic and period properties.
358 359 360 361 362 363 |
# File 'bedrock_agent_core/gateway_base.rb', line 358 def metric(metric_name, props = nil) Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName") props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metric", [metric_name, props]) end |
#metric_duration(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric measuring the duration of requests for this gateway.
The duration metric represents the total time elapsed between receiving the request and sending the final response token, representing complete end-to-end processing time.
372 373 374 375 376 |
# File 'bedrock_agent_core/gateway_base.rb', line 372 def metric_duration(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricDuration", [props]) end |
#metric_invocations(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the total number of invocations for this gateway.
382 383 384 385 386 |
# File 'bedrock_agent_core/gateway_base.rb', line 382 def metric_invocations(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricInvocations", [props]) end |
#metric_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric measuring the latency of requests for this gateway.
The latency metric represents the time elapsed between when the service receives the request and when it begins sending the first response token.
395 396 397 398 399 |
# File 'bedrock_agent_core/gateway_base.rb', line 395 def metric_latency(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricLatency", [props]) end |
#metric_system_errors(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of system errors (5xx status code) for this gateway.
405 406 407 408 409 |
# File 'bedrock_agent_core/gateway_base.rb', line 405 def metric_system_errors(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricSystemErrors", [props]) end |
#metric_target_execution_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric measuring the target execution time for this gateway.
This metric helps determine the contribution of the target (Lambda, OpenAPI, etc.) to the total latency.
418 419 420 421 422 |
# File 'bedrock_agent_core/gateway_base.rb', line 418 def metric_target_execution_time(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricTargetExecutionTime", [props]) end |
#metric_target_type(target_type, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of requests served by each target type for this gateway.
429 430 431 432 433 434 |
# File 'bedrock_agent_core/gateway_base.rb', line 429 def metric_target_type(target_type, props = nil) Jsii::Type.check_type(target_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetType") props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricTargetType", [target_type, props]) end |
#metric_throttles(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of throttled requests (429 status code) for this gateway.
440 441 442 443 444 |
# File 'bedrock_agent_core/gateway_base.rb', line 440 def metric_throttles(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricThrottles", [props]) end |
#metric_user_errors(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.
450 451 452 453 454 |
# File 'bedrock_agent_core/gateway_base.rb', line 450 def metric_user_errors(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricUserErrors", [props]) end |
#node ⇒ Constructs::Node
The tree node.
67 68 69 |
# File 'bedrock_agent_core/gateway_base.rb', line 67 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.
96 97 98 |
# File 'bedrock_agent_core/gateway_base.rb', line 96 def physical_name() jsii_get_property("physicalName") end |
#protocol_configuration ⇒ AWSCDK::BedrockAgentCore::IGatewayProtocolConfig
The protocol configuration for the gateway.
145 146 147 |
# File 'bedrock_agent_core/gateway_base.rb', line 145 def protocol_configuration() jsii_get_property("protocolConfiguration") end |
#role ⇒ AWSCDK::IAM::IRole
The IAM role that provides permissions for the gateway to access AWS services.
152 153 154 |
# File 'bedrock_agent_core/gateway_base.rb', line 152 def role() jsii_get_property("role") end |
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
103 104 105 |
# File 'bedrock_agent_core/gateway_base.rb', line 103 def stack() jsii_get_property("stack") end |
#status ⇒ String?
The status of the gateway.
194 195 196 |
# File 'bedrock_agent_core/gateway_base.rb', line 194 def status() jsii_get_property("status") end |
#status_reason ⇒ Array<String>?
The status reasons for the gateway.
201 202 203 |
# File 'bedrock_agent_core/gateway_base.rb', line 201 def status_reason() jsii_get_property("statusReason") end |
#to_string ⇒ String
Returns a string representation of this construct.
215 216 217 |
# File 'bedrock_agent_core/gateway_base.rb', line 215 def to_string() jsii_call_method("toString", []) end |
#updated_at ⇒ String?
Timestamp when the gateway was last updated.
208 209 210 |
# File 'bedrock_agent_core/gateway_base.rb', line 208 def updated_at() jsii_get_property("updatedAt") 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.
228 229 230 231 232 233 |
# File 'bedrock_agent_core/gateway_base.rb', line 228 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 |