1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bedrockagentcore
  6. GatewayRule

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
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.AwsNative.BedrockAgentCore.Inputs.GatewayRuleAction0Properties, Pulumi.AwsNative.BedrockAgentCore.Inputs.GatewayRuleAction1PropertiesArgs>>
    Priority double
    Conditions List<object>
    Description string
    GatewayIdentifier string
    Actions []interface{}
    Priority float64
    Conditions []interface{}
    Description string
    GatewayIdentifier string
    actions list(object | object)
    priority number
    conditions list(object | object | object)
    description string
    gateway_identifier string
    actions List<Either<GatewayRuleAction0Properties,GatewayRuleAction1PropertiesArgs>>
    priority Double
    conditions List<Object>
    description String
    gatewayIdentifier String
    actions (GatewayRuleAction0Properties | GatewayRuleAction1PropertiesArgs)[]
    priority number
    conditions (GatewayRuleCondition0Properties | GatewayRuleCondition1PropertiesArgs | GatewayRuleCondition2PropertiesArgs)[]
    description string
    gatewayIdentifier string
    actions Sequence[Union[GatewayRuleAction0PropertiesArgs, GatewayRuleAction1PropertiesArgs]]
    priority float
    conditions Sequence[Union[GatewayRuleCondition0PropertiesArgs, GatewayRuleCondition1PropertiesArgs, GatewayRuleCondition2PropertiesArgs]]
    description str
    gateway_identifier str
    actions List<Property Map | Property Map>
    priority Number
    conditions List<Property Map | Property Map | Property Map>
    description String
    gatewayIdentifier String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayRule resource produces the following output properties:

    CreatedAt string
    GatewayArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    Status GatewayRuleStatus
    System GatewayRuleSystemManagedBlock
    UpdatedAt 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
    createdAt String
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    status GatewayRuleStatus
    system GatewayRuleSystemManagedBlock
    updatedAt String
    createdAt string
    gatewayArn string
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    status GatewayRuleStatus
    system GatewayRuleSystemManagedBlock
    updatedAt string
    created_at str
    gateway_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    status GatewayRuleStatus
    system GatewayRuleSystemManagedBlock
    updated_at str
    createdAt String
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    status "CREATING" | "ACTIVE" | "UPDATING" | "DELETING"
    system Property Map
    updatedAt 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) -> GatewayRule
    func 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

    GatewayRuleFallback, GatewayRuleFallbackArgs

    GatewayRuleFallbackError

    NameValue
    ConnectionErrorCONNECTION_ERROR
    FirstByteTimeoutFIRST_BYTE_TIMEOUT
    UnroutableUNROUTABLE
    NameValue
    GatewayRuleFallbackErrorConnectionErrorCONNECTION_ERROR
    GatewayRuleFallbackErrorFirstByteTimeoutFIRST_BYTE_TIMEOUT
    GatewayRuleFallbackErrorUnroutableUNROUTABLE
    Value
    CONNECTION_ERROR
    FIRST_BYTE_TIMEOUT
    UNROUTABLE
    NameValue
    ConnectionErrorCONNECTION_ERROR
    FirstByteTimeoutFIRST_BYTE_TIMEOUT
    UnroutableUNROUTABLE
    NameValue
    ConnectionErrorCONNECTION_ERROR
    FirstByteTimeoutFIRST_BYTE_TIMEOUT
    UnroutableUNROUTABLE
    NameValue
    CONNECTION_ERRORCONNECTION_ERROR
    FIRST_BYTE_TIMEOUTFIRST_BYTE_TIMEOUT
    UNROUTABLEUNROUTABLE
    Value
    CONNECTION_ERROR
    FIRST_BYTE_TIMEOUT
    UNROUTABLE

    GatewayRuleFallbackTarget, GatewayRuleFallbackTargetArgs

    GatewayRuleFallbackTriggers, GatewayRuleFallbackTriggersArgs

    GatewayRuleIamPrincipal, GatewayRuleIamPrincipalArgs

    GatewayRuleMatchModelEntry, GatewayRuleMatchModelEntryArgs

    Value string
    Operator object
    Value string
    Operator interface{}
    value string
    operator any
    value String
    operator Object
    value string
    operator any
    value String
    operator Any

    GatewayRuleMatchModels, GatewayRuleMatchModelsArgs

    GatewayRuleMatchPaths, GatewayRuleMatchPathsArgs

    AnyOf List<string>
    AnyOf []string
    any_of list(string)
    anyOf List<String>
    anyOf string[]
    any_of Sequence[str]
    anyOf List<String>

    GatewayRuleMatchPrincipalEntryProperties, GatewayRuleMatchPrincipalEntryPropertiesArgs

    GatewayRuleMatchPrincipals, GatewayRuleMatchPrincipalsArgs

    GatewayRulePrincipalMatchOperator

    NameValue
    StringEqualsStringEquals
    StringLikeStringLike
    NameValue
    GatewayRulePrincipalMatchOperatorStringEqualsStringEquals
    GatewayRulePrincipalMatchOperatorStringLikeStringLike
    Value
    StringEquals
    StringLike
    NameValue
    StringEqualsStringEquals
    StringLikeStringLike
    NameValue
    StringEqualsStringEquals
    StringLikeStringLike
    NameValue
    STRING_EQUALSStringEquals
    STRING_LIKEStringLike
    Value
    StringEquals
    StringLike

    GatewayRuleRouteToTargetAction0Properties, GatewayRuleRouteToTargetAction0PropertiesArgs

    GatewayRuleRouteToTargetAction1Properties, GatewayRuleRouteToTargetAction1PropertiesArgs

    GatewayRuleStaticOverride, GatewayRuleStaticOverrideArgs

    GatewayRuleStaticRoute, GatewayRuleStaticRouteArgs

    GatewayRuleStatus

    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    DeletingDELETING
    NameValue
    GatewayRuleStatusCreatingCREATING
    GatewayRuleStatusActiveACTIVE
    GatewayRuleStatusUpdatingUPDATING
    GatewayRuleStatusDeletingDELETING
    Value
    CREATING
    ACTIVE
    UPDATING
    DELETING
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    DeletingDELETING
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    DeletingDELETING
    NameValue
    CREATINGCREATING
    ACTIVEACTIVE
    UPDATINGUPDATING
    DELETINGDELETING
    Value
    CREATING
    ACTIVE
    UPDATING
    DELETING

    GatewayRuleSystemManagedBlock

    ManagedBy string
    ManagedBy string
    managed_by string
    managedBy String
    managedBy string
    managedBy String

    GatewayRuleTargetTrafficSplitEntry, GatewayRuleTargetTrafficSplitEntryArgs

    Name string
    TargetName string
    Weight float64
    Description string
    Fallback GatewayRuleFallback
    Metadata map[string]string
    Model string
    name string
    target_name string
    weight number
    description string
    fallback object
    metadata map(string)
    model string
    name String
    targetName String
    weight Double
    description String
    fallback GatewayRuleFallback
    metadata Map<String,String>
    model String
    name string
    targetName string
    weight number
    description string
    fallback GatewayRuleFallback
    metadata {[key: string]: string}
    model string
    name String
    targetName String
    weight Number
    description String
    fallback Property Map
    metadata Map<String>
    model String

    GatewayRuleTrafficSplitEntry, GatewayRuleTrafficSplitEntryArgs

    GatewayRuleWeightedOverride, GatewayRuleWeightedOverrideArgs

    GatewayRuleWeightedRoute, GatewayRuleWeightedRouteArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial