We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Definition of AWS::BedrockAgentCore::Gateway Resource Type
Create Gateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);@overload
def Gateway(resource_name: str,
args: GatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Gateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
authorizer_type: Optional[GatewayAuthorizerType] = None,
protocol_type: Optional[GatewayProtocolType] = None,
role_arn: Optional[str] = None,
authorizer_configuration: Optional[GatewayAuthorizerConfigurationPropertiesArgs] = None,
description: Optional[str] = None,
exception_level: Optional[GatewayExceptionLevel] = None,
interceptor_configurations: Optional[Sequence[GatewayInterceptorConfigurationArgs]] = None,
kms_key_arn: Optional[str] = None,
name: Optional[str] = None,
protocol_configuration: Optional[GatewayProtocolConfigurationPropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: aws-native:bedrockagentcore:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Gateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Gateway resource accepts the following input properties:
-
Pulumi.
Aws Native. Bedrock Agent Core. Gateway Authorizer Type - The authorizer type for the gateway.
- Protocol
Type Pulumi.Aws Native. Bedrock Agent Core. Gateway Protocol Type - The protocol type for the gateway target.
- Role
Arn string -
Pulumi.
Aws Native. Bedrock Agent Core. Inputs. Gateway Authorizer Configuration Properties - Description string
- The description for the gateway.
- Exception
Level Pulumi.Aws Native. Bedrock Agent Core. Gateway Exception Level - The exception level for the gateway.
- Interceptor
Configurations List<Pulumi.Aws Native. Bedrock Agent Core. Inputs. Gateway Interceptor Configuration> - Kms
Key stringArn - The KMS key ARN for the gateway.
- Name string
- The name for the gateway.
- Protocol
Configuration Pulumi.Aws Native. Bedrock Agent Core. Inputs. Gateway Protocol Configuration Properties - The protocol configuration for the gateway target.
- Dictionary<string, string>
- The tags for the gateway.
-
Gateway
Authorizer Type - The authorizer type for the gateway.
- Protocol
Type GatewayProtocol Type - The protocol type for the gateway target.
- Role
Arn string -
Gateway
Authorizer Configuration Properties Args - Description string
- The description for the gateway.
- Exception
Level GatewayException Level - The exception level for the gateway.
- Interceptor
Configurations []GatewayInterceptor Configuration Args - Kms
Key stringArn - The KMS key ARN for the gateway.
- Name string
- The name for the gateway.
- Protocol
Configuration GatewayProtocol Configuration Properties Args - The protocol configuration for the gateway target.
- map[string]string
- The tags for the gateway.
-
Gateway
Authorizer Type - The authorizer type for the gateway.
- protocol
Type GatewayProtocol Type - The protocol type for the gateway target.
- role
Arn String -
Gateway
Authorizer Configuration Properties - description String
- The description for the gateway.
- exception
Level GatewayException Level - The exception level for the gateway.
- interceptor
Configurations List<GatewayInterceptor Configuration> - kms
Key StringArn - The KMS key ARN for the gateway.
- name String
- The name for the gateway.
- protocol
Configuration GatewayProtocol Configuration Properties - The protocol configuration for the gateway target.
- Map<String,String>
- The tags for the gateway.
-
Gateway
Authorizer Type - The authorizer type for the gateway.
- protocol
Type GatewayProtocol Type - The protocol type for the gateway target.
- role
Arn string -
Gateway
Authorizer Configuration Properties - description string
- The description for the gateway.
- exception
Level GatewayException Level - The exception level for the gateway.
- interceptor
Configurations GatewayInterceptor Configuration[] - kms
Key stringArn - The KMS key ARN for the gateway.
- name string
- The name for the gateway.
- protocol
Configuration GatewayProtocol Configuration Properties - The protocol configuration for the gateway target.
- {[key: string]: string}
- The tags for the gateway.
-
Gateway
Authorizer Type - The authorizer type for the gateway.
- protocol_
type GatewayProtocol Type - The protocol type for the gateway target.
- role_
arn str -
Gateway
Authorizer Configuration Properties Args - description str
- The description for the gateway.
- exception_
level GatewayException Level - The exception level for the gateway.
- interceptor_
configurations Sequence[GatewayInterceptor Configuration Args] - kms_
key_ strarn - The KMS key ARN for the gateway.
- name str
- The name for the gateway.
- protocol_
configuration GatewayProtocol Configuration Properties Args - The protocol configuration for the gateway target.
- Mapping[str, str]
- The tags for the gateway.
- "CUSTOM_JWT" | "AWS_IAM" | "NONE"
- The authorizer type for the gateway.
- protocol
Type "MCP" - The protocol type for the gateway target.
- role
Arn String - Property Map
- description String
- The description for the gateway.
- exception
Level "DEBUG" - The exception level for the gateway.
- interceptor
Configurations List<Property Map> - kms
Key StringArn - The KMS key ARN for the gateway.
- name String
- The name for the gateway.
- protocol
Configuration Property Map - The protocol configuration for the gateway target.
- Map<String>
- The tags for the gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Created
At string - The date and time at which the gateway was created.
- Gateway
Arn string - The ARN for the gateway.
- Gateway
Identifier string - Gateway
Url string - The gateway URL for the gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Bedrock Agent Core. Gateway Status - The status for the gateway.
- Status
Reasons List<string> - The status reasons for the gateway.
- Updated
At string - Workload
Identity Pulumi.Details Aws Native. Bedrock Agent Core. Outputs. Gateway Workload Identity Details
- Created
At string - The date and time at which the gateway was created.
- Gateway
Arn string - The ARN for the gateway.
- Gateway
Identifier string - Gateway
Url string - The gateway URL for the gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Gateway
Status - The status for the gateway.
- Status
Reasons []string - The status reasons for the gateway.
- Updated
At string - Workload
Identity GatewayDetails Workload Identity Details
- created
At String - The date and time at which the gateway was created.
- gateway
Arn String - The ARN for the gateway.
- gateway
Identifier String - gateway
Url String - The gateway URL for the gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - The status for the gateway.
- status
Reasons List<String> - The status reasons for the gateway.
- updated
At String - workload
Identity GatewayDetails Workload Identity Details
- created
At string - The date and time at which the gateway was created.
- gateway
Arn string - The ARN for the gateway.
- gateway
Identifier string - gateway
Url string - The gateway URL for the gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - The status for the gateway.
- status
Reasons string[] - The status reasons for the gateway.
- updated
At string - workload
Identity GatewayDetails Workload Identity Details
- created_
at str - The date and time at which the gateway was created.
- gateway_
arn str - The ARN for the gateway.
- gateway_
identifier str - gateway_
url str - The gateway URL for the gateway.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - The status for the gateway.
- status_
reasons Sequence[str] - The status reasons for the gateway.
- updated_
at str - workload_
identity_ Gatewaydetails Workload Identity Details
- created
At String - The date and time at which the gateway was created.
- gateway
Arn String - The ARN for the gateway.
- gateway
Identifier String - gateway
Url String - The gateway URL for the gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED"
- The status for the gateway.
- status
Reasons List<String> - The status reasons for the gateway.
- updated
At String - workload
Identity Property MapDetails
Supporting Types
GatewayAuthorizerConfigurationProperties, GatewayAuthorizerConfigurationPropertiesArgs
GatewayAuthorizerType, GatewayAuthorizerTypeArgs
- Custom
Jwt - CUSTOM_JWT
- Aws
Iam - AWS_IAM
- None
- NONE
- Gateway
Authorizer Type Custom Jwt - CUSTOM_JWT
- Gateway
Authorizer Type Aws Iam - AWS_IAM
- Gateway
Authorizer Type None - NONE
- Custom
Jwt - CUSTOM_JWT
- Aws
Iam - AWS_IAM
- None
- NONE
- Custom
Jwt - CUSTOM_JWT
- Aws
Iam - AWS_IAM
- None
- NONE
- CUSTOM_JWT
- CUSTOM_JWT
- AWS_IAM
- AWS_IAM
- NONE
- NONE
- "CUSTOM_JWT"
- CUSTOM_JWT
- "AWS_IAM"
- AWS_IAM
- "NONE"
- NONE
GatewayAuthorizingClaimMatchValueType, GatewayAuthorizingClaimMatchValueTypeArgs
The value or values in the custom claim to match and relationship of matchGatewayClaimMatchOperator, GatewayClaimMatchOperatorArgs
- Equals
Value - EQUALS
- Contains
- CONTAINS
- Contains
Any - CONTAINS_ANY
- Gateway
Claim Match Operator Equals - EQUALS
- Gateway
Claim Match Operator Contains - CONTAINS
- Gateway
Claim Match Operator Contains Any - CONTAINS_ANY
- Equals
- EQUALS
- Contains
- CONTAINS
- Contains
Any - CONTAINS_ANY
- Equals
- EQUALS
- Contains
- CONTAINS
- Contains
Any - CONTAINS_ANY
- EQUALS
- EQUALS
- CONTAINS
- CONTAINS
- CONTAINS_ANY
- CONTAINS_ANY
- "EQUALS"
- EQUALS
- "CONTAINS"
- CONTAINS
- "CONTAINS_ANY"
- CONTAINS_ANY
GatewayClaimMatchValueType, GatewayClaimMatchValueTypeArgs
The value or values in the custom claim to match for- Match
Value stringString - Match
Value List<string>String List
- Match
Value stringString - Match
Value []stringString List
- match
Value StringString - match
Value List<String>String List
- match
Value stringString - match
Value string[]String List
- match_
value_ strstring - match_
value_ Sequence[str]string_ list
- match
Value StringString - match
Value List<String>String List
GatewayCustomClaimValidationType, GatewayCustomClaimValidationTypeArgs
Required custom claimGatewayCustomJwtAuthorizerConfiguration, GatewayCustomJwtAuthorizerConfigurationArgs
- Discovery
Url string - Allowed
Audience List<string> - Allowed
Clients List<string> - Allowed
Scopes List<string> - Custom
Claims List<Pulumi.Aws Native. Bedrock Agent Core. Inputs. Gateway Custom Claim Validation Type>
- Discovery
Url string - Allowed
Audience []string - Allowed
Clients []string - Allowed
Scopes []string - Custom
Claims []GatewayCustom Claim Validation Type
- discovery
Url String - allowed
Audience List<String> - allowed
Clients List<String> - allowed
Scopes List<String> - custom
Claims List<GatewayCustom Claim Validation Type>
- discovery
Url string - allowed
Audience string[] - allowed
Clients string[] - allowed
Scopes string[] - custom
Claims GatewayCustom Claim Validation Type[]
- discovery_
url str - allowed_
audience Sequence[str] - allowed_
clients Sequence[str] - allowed_
scopes Sequence[str] - custom_
claims Sequence[GatewayCustom Claim Validation Type]
- discovery
Url String - allowed
Audience List<String> - allowed
Clients List<String> - allowed
Scopes List<String> - custom
Claims List<Property Map>
GatewayExceptionLevel, GatewayExceptionLevelArgs
- Debug
- DEBUG
- Gateway
Exception Level Debug - DEBUG
- Debug
- DEBUG
- Debug
- DEBUG
- DEBUG
- DEBUG
- "DEBUG"
- DEBUG
GatewayInboundTokenClaimValueType, GatewayInboundTokenClaimValueTypeArgs
- String
- STRING
- String
Array - STRING_ARRAY
- Gateway
Inbound Token Claim Value Type String - STRING
- Gateway
Inbound Token Claim Value Type String Array - STRING_ARRAY
- String
- STRING
- String
Array - STRING_ARRAY
- String
- STRING
- String
Array - STRING_ARRAY
- STRING
- STRING
- STRING_ARRAY
- STRING_ARRAY
- "STRING"
- STRING
- "STRING_ARRAY"
- STRING_ARRAY
GatewayInterceptionPoint, GatewayInterceptionPointArgs
- Request
- REQUEST
- Response
- RESPONSE
- Gateway
Interception Point Request - REQUEST
- Gateway
Interception Point Response - RESPONSE
- Request
- REQUEST
- Response
- RESPONSE
- Request
- REQUEST
- Response
- RESPONSE
- REQUEST
- REQUEST
- RESPONSE
- RESPONSE
- "REQUEST"
- REQUEST
- "RESPONSE"
- RESPONSE
GatewayInterceptorConfiguration, GatewayInterceptorConfigurationArgs
GatewayInterceptorInputConfiguration, GatewayInterceptorInputConfigurationArgs
- Pass
Request boolHeaders
- Pass
Request boolHeaders
- pass
Request BooleanHeaders
- pass
Request booleanHeaders
- pass_
request_ boolheaders
- pass
Request BooleanHeaders
GatewayLambdaInterceptorConfiguration, GatewayLambdaInterceptorConfigurationArgs
- Arn string
- Arn string
- arn String
- arn string
- arn str
- arn String
GatewayMcpGatewayConfiguration, GatewayMcpGatewayConfigurationArgs
- Instructions string
- Search
Type GatewaySearch Type - Supported
Versions []string
- instructions String
- search
Type GatewaySearch Type - supported
Versions List<String>
- instructions string
- search
Type GatewaySearch Type - supported
Versions string[]
- instructions str
- search_
type GatewaySearch Type - supported_
versions Sequence[str]
- instructions String
- search
Type "SEMANTIC" - supported
Versions List<String>
GatewayProtocolConfigurationProperties, GatewayProtocolConfigurationPropertiesArgs
GatewayProtocolType, GatewayProtocolTypeArgs
- Mcp
- MCP
- Gateway
Protocol Type Mcp - MCP
- Mcp
- MCP
- Mcp
- MCP
- MCP
- MCP
- "MCP"
- MCP
GatewaySearchType, GatewaySearchTypeArgs
- Semantic
- SEMANTIC
- Gateway
Search Type Semantic - SEMANTIC
- Semantic
- SEMANTIC
- Semantic
- SEMANTIC
- SEMANTIC
- SEMANTIC
- "SEMANTIC"
- SEMANTIC
GatewayStatus, GatewayStatusArgs
- Creating
- CREATING
- Updating
- UPDATING
- Update
Unsuccessful - UPDATE_UNSUCCESSFUL
- Deleting
- DELETING
- Ready
- READY
- Failed
- FAILED
- Gateway
Status Creating - CREATING
- Gateway
Status Updating - UPDATING
- Gateway
Status Update Unsuccessful - UPDATE_UNSUCCESSFUL
- Gateway
Status Deleting - DELETING
- Gateway
Status Ready - READY
- Gateway
Status Failed - FAILED
- Creating
- CREATING
- Updating
- UPDATING
- Update
Unsuccessful - UPDATE_UNSUCCESSFUL
- Deleting
- DELETING
- Ready
- READY
- Failed
- FAILED
- Creating
- CREATING
- Updating
- UPDATING
- Update
Unsuccessful - UPDATE_UNSUCCESSFUL
- Deleting
- DELETING
- Ready
- READY
- Failed
- FAILED
- CREATING
- CREATING
- UPDATING
- UPDATING
- UPDATE_UNSUCCESSFUL
- UPDATE_UNSUCCESSFUL
- DELETING
- DELETING
- READY
- READY
- FAILED
- FAILED
- "CREATING"
- CREATING
- "UPDATING"
- UPDATING
- "UPDATE_UNSUCCESSFUL"
- UPDATE_UNSUCCESSFUL
- "DELETING"
- DELETING
- "READY"
- READY
- "FAILED"
- FAILED
GatewayWorkloadIdentityDetails, GatewayWorkloadIdentityDetailsArgs
- Workload
Identity stringArn
- Workload
Identity stringArn
- workload
Identity StringArn
- workload
Identity stringArn
- workload
Identity StringArn
InterceptorConfigurationProperties, InterceptorConfigurationPropertiesArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
