We recommend new projects start with resources from the AWS provider.
aws-native.bedrockagentcore.Gateway
Explore with Pulumi AI
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,
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 - Protocol
Type Pulumi.Aws Native. Bedrock Agent Core. Gateway Protocol Type - Role
Arn string - Pulumi.
Aws Native. Bedrock Agent Core. Inputs. Gateway Authorizer Configuration Properties - Description string
- Exception
Level Pulumi.Aws Native. Bedrock Agent Core. Gateway Exception Level - Kms
Key stringArn - Name string
- Protocol
Configuration Pulumi.Aws Native. Bedrock Agent Core. Inputs. Gateway Protocol Configuration Properties - Dictionary<string, string>
- Gateway
Authorizer Type - protocol
Type GatewayProtocol Type - role
Arn string - Gateway
Authorizer Configuration Properties - description string
- exception
Level GatewayException Level - kms
Key stringArn - name string
- protocol
Configuration GatewayProtocol Configuration Properties - {[key: string]: string}
- "CUSTOM_JWT" | "AWS_IAM"
- protocol
Type "MCP" - role
Arn String - Property Map
- description String
- exception
Level "DEBUG" - kms
Key StringArn - name String
- protocol
Configuration Property Map - Map<String>
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Created
At string - Gateway
Arn string - Gateway
Identifier string - Gateway
Url string - Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Bedrock Agent Core. Gateway Status - Status
Reasons List<string> - Updated
At string - Workload
Identity Pulumi.Details Aws Native. Bedrock Agent Core. Outputs. Gateway Workload Identity Details
- Created
At string - Gateway
Arn string - Gateway
Identifier string - Gateway
Url string - Id string
- The provider-assigned unique ID for this managed resource.
- Status
Gateway
Status - Status
Reasons []string - Updated
At string - Workload
Identity GatewayDetails Workload Identity Details
- created
At String - gateway
Arn String - gateway
Identifier String - gateway
Url String - id String
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - status
Reasons List<String> - updated
At String - workload
Identity GatewayDetails Workload Identity Details
- created
At string - gateway
Arn string - gateway
Identifier string - gateway
Url string - id string
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - status
Reasons string[] - updated
At string - workload
Identity GatewayDetails Workload Identity Details
- created_
at str - gateway_
arn str - gateway_
identifier str - gateway_
url str - id str
- The provider-assigned unique ID for this managed resource.
- status
Gateway
Status - status_
reasons Sequence[str] - updated_
at str - workload_
identity_ Gatewaydetails Workload Identity Details
- created
At String - gateway
Arn String - gateway
Identifier String - gateway
Url String - id String
- The provider-assigned unique ID for this managed resource.
- status "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED"
- status
Reasons List<String> - updated
At String - workload
Identity Property MapDetails
Supporting Types
GatewayAuthorizerConfigurationProperties, GatewayAuthorizerConfigurationPropertiesArgs
GatewayAuthorizerType, GatewayAuthorizerTypeArgs
- Custom
Jwt - CUSTOM_JWT
- Aws
Iam - AWS_IAM
- Gateway
Authorizer Type Custom Jwt - CUSTOM_JWT
- Gateway
Authorizer Type Aws Iam - AWS_IAM
- Custom
Jwt - CUSTOM_JWT
- Aws
Iam - AWS_IAM
- Custom
Jwt - CUSTOM_JWT
- Aws
Iam - AWS_IAM
- CUSTOM_JWT
- CUSTOM_JWT
- AWS_IAM
- AWS_IAM
- "CUSTOM_JWT"
- CUSTOM_JWT
- "AWS_IAM"
- AWS_IAM
GatewayCustomJwtAuthorizerConfiguration, GatewayCustomJwtAuthorizerConfigurationArgs
- Discovery
Url string - Allowed
Audience List<string> - Allowed
Clients List<string>
- Discovery
Url string - Allowed
Audience []string - Allowed
Clients []string
- discovery
Url String - allowed
Audience List<String> - allowed
Clients List<String>
- discovery
Url string - allowed
Audience string[] - allowed
Clients string[]
- discovery_
url str - allowed_
audience Sequence[str] - allowed_
clients Sequence[str]
- discovery
Url String - allowed
Audience List<String> - allowed
Clients List<String>
GatewayExceptionLevel, GatewayExceptionLevelArgs
- Debug
- DEBUG
- Gateway
Exception Level Debug - DEBUG
- Debug
- DEBUG
- Debug
- DEBUG
- DEBUG
- DEBUG
- "DEBUG"
- DEBUG
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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.