We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::BedrockAgentCore::GatewayRule
Create GatewayRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayRule(name: string, args: GatewayRuleArgs, opts?: CustomResourceOptions);@overload
def GatewayRule(resource_name: str,
args: GatewayRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
actions: Optional[Sequence[Union[GatewayRuleAction0PropertiesArgs, GatewayRuleAction1PropertiesArgs]]] = None,
priority: Optional[float] = None,
conditions: Optional[Sequence[Union[GatewayRuleCondition0PropertiesArgs, GatewayRuleCondition1PropertiesArgs, GatewayRuleCondition2PropertiesArgs]]] = None,
description: Optional[str] = None,
gateway_identifier: Optional[str] = None)func NewGatewayRule(ctx *Context, name string, args GatewayRuleArgs, opts ...ResourceOption) (*GatewayRule, error)public GatewayRule(string name, GatewayRuleArgs args, CustomResourceOptions? opts = null)
public GatewayRule(String name, GatewayRuleArgs args)
public GatewayRule(String name, GatewayRuleArgs args, CustomResourceOptions options)
type: aws-native:bedrockagentcore:GatewayRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_bedrockagentcore_gateway_rule" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GatewayRuleArgs
- 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 GatewayRuleArgs
- 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 GatewayRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GatewayRule 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 GatewayRule resource accepts the following input properties:
- Actions
List<Union<Pulumi.
Aws Native. Bedrock Agent Core. Inputs. Gateway Rule Action0Properties, Pulumi. Aws Native. Bedrock Agent Core. Inputs. Gateway Rule Action1Properties Args>> - Priority double
- Conditions List<object>
- Description string
- Gateway
Identifier string
- Actions []interface{}
- Priority float64
- Conditions []interface{}
- Description string
- Gateway
Identifier string
- actions list(object | object)
- priority number
- conditions list(object | object | object)
- description string
- gateway_
identifier string
- actions
List<Either<Gateway
Rule Action0Properties,Gateway Rule Action1Properties Args>> - priority Double
- conditions List<Object>
- description String
- gateway
Identifier String
- actions
(Gateway
Rule Action0Properties | Gateway Rule Action1Properties Args)[] - priority number
- conditions
(Gateway
Rule Condition0Properties | Gateway Rule Condition1Properties Args | Gateway Rule Condition2Properties Args)[] - description string
- gateway
Identifier string
- actions
Sequence[Union[Gateway
Rule Action0Properties Args, Gateway Rule Action1Properties Args]] - priority float
- conditions
Sequence[Union[Gateway
Rule Condition0Properties Args, Gateway Rule Condition1Properties Args, Gateway Rule Condition2Properties Args]] - description str
- gateway_
identifier str
- actions List<Property Map | Property Map>
- priority Number
- conditions List<Property Map | Property Map | Property Map>
- description String
- gateway
Identifier String
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayRule resource produces the following output properties:
- Created
At string - Gateway
Arn string - Id string
- The provider-assigned unique ID for this managed resource.
- Rule
Id string - Status
Pulumi.
Aws Native. Bedrock Agent Core. Gateway Rule Status - System
Pulumi.
Aws Native. Bedrock Agent Core. Outputs. Gateway Rule System Managed Block - Updated
At string
- Created
At string - Gateway
Arn string - Id string
- The provider-assigned unique ID for this managed resource.
- Rule
Id string - Status
Gateway
Rule Status - System
Gateway
Rule System Managed Block - Updated
At string
- created_
at string - gateway_
arn string - id string
- The provider-assigned unique ID for this managed resource.
- rule_
id string - status "CREATING" | "ACTIVE" | "UPDATING" | "DELETING"
- system object
- updated_
at string
- created
At String - gateway
Arn String - id String
- The provider-assigned unique ID for this managed resource.
- rule
Id String - status
Gateway
Rule Status - system
Gateway
Rule System Managed Block - updated
At String
- created
At string - gateway
Arn string - id string
- The provider-assigned unique ID for this managed resource.
- rule
Id string - status
Gateway
Rule Status - system
Gateway
Rule System Managed Block - updated
At string
- created_
at str - gateway_
arn str - id str
- The provider-assigned unique ID for this managed resource.
- rule_
id str - status
Gateway
Rule Status - system
Gateway
Rule System Managed Block - updated_
at str
- created
At String - gateway
Arn String - id String
- The provider-assigned unique ID for this managed resource.
- rule
Id String - status "CREATING" | "ACTIVE" | "UPDATING" | "DELETING"
- system Property Map
- updated
At String
Look up Existing GatewayRule Resource
Get an existing GatewayRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): GatewayRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> GatewayRulefunc GetGatewayRule(ctx *Context, name string, id IDInput, state *GatewayRuleState, opts ...ResourceOption) (*GatewayRule, error)public static GatewayRule Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static GatewayRule get(String name, Output<String> id, CustomResourceOptions options)resources: existingGatewayRule: type: aws-native:bedrockagentcore:GatewayRule get: id: ${id}import {
to = aws-native_bedrockagentcore_gateway_rule.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state GatewayRuleState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
GatewayRuleAction0Properties, GatewayRuleAction0PropertiesArgs
GatewayRuleAction1Properties, GatewayRuleAction1PropertiesArgs
GatewayRuleCircuitBreakerConfiguration, GatewayRuleCircuitBreakerConfigurationArgs
- Mode object
- Mode interface{}
- mode any
- mode Object
- mode any
- mode Any
- mode Any
GatewayRuleCondition0Properties, GatewayRuleCondition0PropertiesArgs
GatewayRuleCondition1Properties, GatewayRuleCondition1PropertiesArgs
GatewayRuleCondition2Properties, GatewayRuleCondition2PropertiesArgs
GatewayRuleConfigurationBundleAction0Properties, GatewayRuleConfigurationBundleAction0PropertiesArgs
GatewayRuleConfigurationBundleAction1Properties, GatewayRuleConfigurationBundleAction1PropertiesArgs
GatewayRuleConfigurationBundleReference, GatewayRuleConfigurationBundleReferenceArgs
- Bundle
Arn string - Bundle
Version string
- Bundle
Arn string - Bundle
Version string
- bundle_
arn string - bundle_
version string
- bundle
Arn String - bundle
Version String
- bundle
Arn string - bundle
Version string
- bundle_
arn str - bundle_
version str
- bundle
Arn String - bundle
Version String
GatewayRuleFallback, GatewayRuleFallbackArgs
GatewayRuleFallbackError
| Name | Value |
|---|---|
| Connection | CONNECTION_ERROR |
| First | FIRST_BYTE_TIMEOUT |
| Unroutable | UNROUTABLE |
| Name | Value |
|---|---|
| Gateway | CONNECTION_ERROR |
| Gateway | FIRST_BYTE_TIMEOUT |
| Gateway | UNROUTABLE |
| Value |
|---|
CONNECTION_ERROR |
FIRST_BYTE_TIMEOUT |
UNROUTABLE |
| Name | Value |
|---|---|
| Connection | CONNECTION_ERROR |
| First | FIRST_BYTE_TIMEOUT |
| Unroutable | UNROUTABLE |
| Name | Value |
|---|---|
| Connection | CONNECTION_ERROR |
| First | FIRST_BYTE_TIMEOUT |
| Unroutable | UNROUTABLE |
| Name | Value |
|---|---|
| CONNECTION_ERROR | CONNECTION_ERROR |
| FIRST_BYTE_TIMEOUT | FIRST_BYTE_TIMEOUT |
| UNROUTABLE | UNROUTABLE |
| Value |
|---|
CONNECTION_ERROR |
FIRST_BYTE_TIMEOUT |
UNROUTABLE |
GatewayRuleFallbackTarget, GatewayRuleFallbackTargetArgs
- target_
name string - first_
byte_ numbertimeout_ milliseconds - model string
- trigger_
on object
- target
Name String - first
Byte IntegerTimeout Milliseconds - model String
- trigger
On GatewayRule Fallback Triggers
- target
Name string - first
Byte numberTimeout Milliseconds - model string
- trigger
On GatewayRule Fallback Triggers
- target
Name String - first
Byte NumberTimeout Milliseconds - model String
- trigger
On Property Map
GatewayRuleFallbackTriggers, GatewayRuleFallbackTriggersArgs
- errors
List<Gateway
Rule Fallback Error> - status
Codes List<String>
- errors
Sequence[Gateway
Rule Fallback Error] - status_
codes Sequence[str]
GatewayRuleIamPrincipal, GatewayRuleIamPrincipalArgs
GatewayRuleMatchModelEntry, GatewayRuleMatchModelEntryArgs
GatewayRuleMatchModels, GatewayRuleMatchModelsArgs
GatewayRuleMatchPaths, GatewayRuleMatchPathsArgs
- Any
Of List<string>
- Any
Of []string
- any_
of list(string)
- any
Of List<String>
- any
Of string[]
- any_
of Sequence[str]
- any
Of List<String>
GatewayRuleMatchPrincipalEntryProperties, GatewayRuleMatchPrincipalEntryPropertiesArgs
GatewayRuleMatchPrincipals, GatewayRuleMatchPrincipalsArgs
GatewayRulePrincipalMatchOperator
| Name | Value |
|---|---|
| String | StringEquals |
| String | StringLike |
| Name | Value |
|---|---|
| Gateway | StringEquals |
| Gateway | StringLike |
| Value |
|---|
StringEquals |
StringLike |
| Name | Value |
|---|---|
| String | StringEquals |
| String | StringLike |
| Name | Value |
|---|---|
| String | StringEquals |
| String | StringLike |
| Name | Value |
|---|---|
| STRING_EQUALS | StringEquals |
| STRING_LIKE | StringLike |
| Value |
|---|
StringEquals |
StringLike |
GatewayRuleRouteToTargetAction0Properties, GatewayRuleRouteToTargetAction0PropertiesArgs
GatewayRuleRouteToTargetAction1Properties, GatewayRuleRouteToTargetAction1PropertiesArgs
GatewayRuleStaticOverride, GatewayRuleStaticOverrideArgs
- Bundle
Arn string - Bundle
Version string
- Bundle
Arn string - Bundle
Version string
- bundle_
arn string - bundle_
version string
- bundle
Arn String - bundle
Version String
- bundle
Arn string - bundle
Version string
- bundle_
arn str - bundle_
version str
- bundle
Arn String - bundle
Version String
GatewayRuleStaticRoute, GatewayRuleStaticRouteArgs
- Target
Name string - Fallback
Gateway
Rule Fallback - Model string
- target_
name string - fallback object
- model string
- target
Name String - fallback
Gateway
Rule Fallback - model String
- target
Name string - fallback
Gateway
Rule Fallback - model string
- target
Name String - fallback Property Map
- model String
GatewayRuleStatus
| Name | Value |
|---|---|
| Creating | CREATING |
| Active | ACTIVE |
| Updating | UPDATING |
| Deleting | DELETING |
| Name | Value |
|---|---|
| Gateway | CREATING |
| Gateway | ACTIVE |
| Gateway | UPDATING |
| Gateway | DELETING |
| Value |
|---|
CREATING |
ACTIVE |
UPDATING |
DELETING |
| Name | Value |
|---|---|
| Creating | CREATING |
| Active | ACTIVE |
| Updating | UPDATING |
| Deleting | DELETING |
| Name | Value |
|---|---|
| Creating | CREATING |
| Active | ACTIVE |
| Updating | UPDATING |
| Deleting | DELETING |
| Name | Value |
|---|---|
| CREATING | CREATING |
| ACTIVE | ACTIVE |
| UPDATING | UPDATING |
| DELETING | DELETING |
| Value |
|---|
CREATING |
ACTIVE |
UPDATING |
DELETING |
GatewayRuleSystemManagedBlock
- Managed
By string
- Managed
By string
- managed_
by string
- managed
By String
- managed
By string
- managed_
by str
- managed
By String
GatewayRuleTargetTrafficSplitEntry, GatewayRuleTargetTrafficSplitEntryArgs
- Name string
- Target
Name string - Weight double
- Description string
- Fallback
Pulumi.
Aws Native. Bedrock Agent Core. Inputs. Gateway Rule Fallback - Metadata Dictionary<string, string>
- Model string
- Name string
- Target
Name string - Weight float64
- Description string
- Fallback
Gateway
Rule Fallback - Metadata map[string]string
- Model string
- name string
- target_
name string - weight number
- description string
- fallback object
- metadata map(string)
- model string
- name String
- target
Name String - weight Double
- description String
- fallback
Gateway
Rule Fallback - metadata Map<String,String>
- model String
- name string
- target
Name string - weight number
- description string
- fallback
Gateway
Rule Fallback - metadata {[key: string]: string}
- model string
- name str
- target_
name str - weight float
- description str
- fallback
Gateway
Rule Fallback - metadata Mapping[str, str]
- model str
- name String
- target
Name String - weight Number
- description String
- fallback Property Map
- metadata Map<String>
- model String
GatewayRuleTrafficSplitEntry, GatewayRuleTrafficSplitEntryArgs
- Configuration
Bundle Pulumi.Aws Native. Bedrock Agent Core. Inputs. Gateway Rule Configuration Bundle Reference - Name string
- Weight double
- Description string
- Metadata Dictionary<string, string>
- Configuration
Bundle GatewayRule Configuration Bundle Reference - Name string
- Weight float64
- Description string
- Metadata map[string]string
- configuration_
bundle object - name string
- weight number
- description string
- metadata map(string)
- configuration
Bundle GatewayRule Configuration Bundle Reference - name String
- weight Double
- description String
- metadata Map<String,String>
- configuration
Bundle GatewayRule Configuration Bundle Reference - name string
- weight number
- description string
- metadata {[key: string]: string}
- configuration_
bundle GatewayRule Configuration Bundle Reference - name str
- weight float
- description str
- metadata Mapping[str, str]
- configuration
Bundle Property Map - name String
- weight Number
- description String
- metadata Map<String>
GatewayRuleWeightedOverride, GatewayRuleWeightedOverrideArgs
GatewayRuleWeightedRoute, GatewayRuleWeightedRouteArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi