Class: AWSCDK::BedrockAgentCore::GatewayIAMRoleCredentialProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock_agent_core/gateway_iam_role_credential_provider_props.rb

Overview

Properties for configuring the IAM role credential provider.

When a target is authenticated via the gateway's execution role, the gateway signs outbound requests with SigV4. These properties let you tell the gateway which AWS service and region to sign for, instead of letting it infer them from the target endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(region: nil, service: nil) ⇒ GatewayIAMRoleCredentialProviderProps

Returns a new instance of GatewayIAMRoleCredentialProviderProps.

Parameters:

  • region (String, nil) (defaults to: nil) —

    The AWS Region used for SigV4 signing of outbound requests. Can be up to 32 characters long.

  • service (String, nil) (defaults to: nil) —

    The AWS service name used for SigV4 signing of outbound requests.



14
15
16
17
18
19
 
# File 'bedrock_agent_core/gateway_iam_role_credential_provider_props.rb', line 14

def initialize(region: nil, service: nil)
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
  @service = service
  Jsii::Type.check_type(@service, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "service") unless @service.nil?
end

Instance Attribute Details

#region ⇒ String? (readonly)

Note:

Default: - Gateway's own Region

The AWS Region used for SigV4 signing of outbound requests. Can be up to 32 characters long.

Pattern: ^[a-zA-Z0-9-]+$

Returns:

  • (String, nil) 


27
28
29
 
# File 'bedrock_agent_core/gateway_iam_role_credential_provider_props.rb', line 27

def region
  @region
end

#service ⇒ String? (readonly)

Note:

Default: - Gateway infers the service from the target endpoint

The AWS service name used for SigV4 signing of outbound requests.

Use the SigV4 signing name (typically the endpoint prefix), e.g. bedrock-runtime, s3, execute-api, dynamodb. Can be up to 64 characters long.

Pattern: ^[a-zA-Z0-9._-]+$

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'bedrock_agent_core/gateway_iam_role_credential_provider_props.rb', line 39

def service
  @service
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
 
# File 'bedrock_agent_core/gateway_iam_role_credential_provider_props.rb', line 41

def self.jsii_properties
  {
    :region => "region",
    :service => "service",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'bedrock_agent_core/gateway_iam_role_credential_provider_props.rb', line 48

def to_jsii
  result = {}
  result.merge!({
    "region" => @region,
    "service" => @service,
  })
  result.compact
end