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.78.0
published on Monday, Sep 7, 2026 by Pulumi
aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 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]]] = 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<Union<Pulumi.AwsNative.BedrockAgentCore.Inputs.GatewayRuleCondition0Properties, Pulumi.AwsNative.BedrockAgentCore.Inputs.GatewayRuleCondition1PropertiesArgs>>
    Description string
    GatewayIdentifier string
    Actions []interface{}
    Priority float64
    Conditions []interface{}
    Description string
    GatewayIdentifier string
    actions list(object | object)
    priority number
    conditions list(object | object)
    description string
    gateway_identifier string
    actions List<Either<GatewayRuleAction0Properties,GatewayRuleAction1PropertiesArgs>>
    priority Double
    conditions List<Either<GatewayRuleCondition0Properties,GatewayRuleCondition1PropertiesArgs>>
    description String
    gatewayIdentifier String
    actions (GatewayRuleAction0Properties | GatewayRuleAction1PropertiesArgs)[]
    priority number
    conditions (GatewayRuleCondition0Properties | GatewayRuleCondition1PropertiesArgs)[]
    description string
    gatewayIdentifier string
    actions Sequence[Union[GatewayRuleAction0PropertiesArgs, GatewayRuleAction1PropertiesArgs]]
    priority float
    conditions Sequence[Union[GatewayRuleCondition0PropertiesArgs, GatewayRuleCondition1PropertiesArgs]]
    description str
    gateway_identifier str
    actions List<Property Map | Property Map>
    priority Number
    conditions List<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 Pulumi.AwsNative.BedrockAgentCore.GatewayRuleStatus
    UpdatedAt string
    CreatedAt string
    GatewayArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    Status GatewayRuleStatus
    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"
    updated_at string
    createdAt String
    gatewayArn String
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    status GatewayRuleStatus
    updatedAt String
    createdAt string
    gatewayArn string
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    status GatewayRuleStatus
    updatedAt string
    created_at str
    gateway_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    status GatewayRuleStatus
    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"
    updatedAt String

    Supporting Types

    GatewayRuleAction0Properties, GatewayRuleAction0PropertiesArgs

    GatewayRuleAction1Properties, GatewayRuleAction1PropertiesArgs

    GatewayRuleCondition0Properties, GatewayRuleCondition0PropertiesArgs

    GatewayRuleCondition1Properties, GatewayRuleCondition1PropertiesArgs

    GatewayRuleConfigurationBundleAction0Properties, GatewayRuleConfigurationBundleAction0PropertiesArgs

    GatewayRuleConfigurationBundleAction1Properties, GatewayRuleConfigurationBundleAction1PropertiesArgs

    GatewayRuleConfigurationBundleReference, GatewayRuleConfigurationBundleReferenceArgs

    GatewayRuleIamPrincipal, GatewayRuleIamPrincipalArgs

    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, GatewayRulePrincipalMatchOperatorArgs

    StringEquals
    StringEquals
    StringLike
    StringLike
    GatewayRulePrincipalMatchOperatorStringEquals
    StringEquals
    GatewayRulePrincipalMatchOperatorStringLike
    StringLike
    "StringEquals"
    StringEquals
    "StringLike"
    StringLike
    StringEquals
    StringEquals
    StringLike
    StringLike
    StringEquals
    StringEquals
    StringLike
    StringLike
    STRING_EQUALS
    StringEquals
    STRING_LIKE
    StringLike
    "StringEquals"
    StringEquals
    "StringLike"
    StringLike

    GatewayRuleRouteToTargetAction0Properties, GatewayRuleRouteToTargetAction0PropertiesArgs

    GatewayRuleRouteToTargetAction1Properties, GatewayRuleRouteToTargetAction1PropertiesArgs

    GatewayRuleStaticOverride, GatewayRuleStaticOverrideArgs

    GatewayRuleStaticRoute, GatewayRuleStaticRouteArgs

    TargetName string
    TargetName string
    targetName String
    targetName string
    targetName String

    GatewayRuleStatus, GatewayRuleStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleting
    DELETING
    GatewayRuleStatusCreating
    CREATING
    GatewayRuleStatusActive
    ACTIVE
    GatewayRuleStatusUpdating
    UPDATING
    GatewayRuleStatusDeleting
    DELETING
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "UPDATING"
    UPDATING
    "DELETING"
    DELETING
    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleting
    DELETING
    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleting
    DELETING
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    UPDATING
    UPDATING
    DELETING
    DELETING
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "UPDATING"
    UPDATING
    "DELETING"
    DELETING

    GatewayRuleTargetTrafficSplitEntry, GatewayRuleTargetTrafficSplitEntryArgs

    Name string
    TargetName string
    Weight double
    Description string
    Metadata Dictionary<string, string>
    Name string
    TargetName string
    Weight float64
    Description string
    Metadata map[string]string
    name string
    target_name string
    weight number
    description string
    metadata map(string)
    name String
    targetName String
    weight Double
    description String
    metadata Map<String,String>
    name string
    targetName string
    weight number
    description string
    metadata {[key: string]: string}
    name str
    target_name str
    weight float
    description str
    metadata Mapping[str, str]
    name String
    targetName String
    weight Number
    description String
    metadata Map<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

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

    Viewing docs for AWS Cloud Control v1.78.0
    published on Monday, Sep 7, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial