1. Packages
  2. AWS Native
  3. API Docs
  4. vpclattice
  5. Rule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.vpclattice.Rule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.

    Create Rule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             action: Optional[RuleActionArgs] = None,
             match: Optional[RuleMatchArgs] = None,
             priority: Optional[int] = None,
             listener_identifier: Optional[str] = None,
             name: Optional[str] = None,
             service_identifier: Optional[str] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
    public Rule(String name, RuleArgs args, CustomResourceOptions options)
    
    type: aws-native:vpclattice:Rule
    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 RuleArgs
    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 RuleArgs
    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 RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampleruleResourceResourceFromVpclattice = new aws_native.vpclattice.Rule("exampleruleResourceResourceFromVpclattice", {
        action: {
            fixedResponse: {
                statusCode: 0,
            },
            forward: {
                targetGroups: [{
                    targetGroupIdentifier: "string",
                    weight: 0,
                }],
            },
        },
        match: {
            httpMatch: {
                headerMatches: [{
                    match: {
                        contains: "string",
                        exact: "string",
                        prefix: "string",
                    },
                    name: "string",
                    caseSensitive: false,
                }],
                method: aws_native.vpclattice.RuleHttpMatchMethod.Connect,
                pathMatch: {
                    match: {
                        exact: "string",
                        prefix: "string",
                    },
                    caseSensitive: false,
                },
            },
        },
        priority: 0,
        listenerIdentifier: "string",
        name: "string",
        serviceIdentifier: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Rule resource accepts the following input properties:

    Outputs

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

    Arn string
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    RuleAction, RuleActionArgs

    RuleFixedResponse, RuleFixedResponseArgs

    statusCode Integer
    statusCode number
    statusCode Number

    RuleForward, RuleForwardArgs

    RuleHeaderMatch, RuleHeaderMatchArgs

    RuleHeaderMatchType, RuleHeaderMatchTypeArgs

    Contains string
    Exact string
    Prefix string
    Contains string
    Exact string
    Prefix string
    contains String
    exact String
    prefix String
    contains string
    exact string
    prefix string
    contains String
    exact String
    prefix String

    RuleHttpMatch, RuleHttpMatchArgs

    RuleHttpMatchMethod, RuleHttpMatchMethodArgs

    Connect
    CONNECT
    Delete
    DELETE
    Get
    GET
    Head
    HEAD
    Options
    OPTIONS
    Post
    POST
    Put
    PUT
    Trace
    TRACE
    RuleHttpMatchMethodConnect
    CONNECT
    RuleHttpMatchMethodDelete
    DELETE
    RuleHttpMatchMethodGet
    GET
    RuleHttpMatchMethodHead
    HEAD
    RuleHttpMatchMethodOptions
    OPTIONS
    RuleHttpMatchMethodPost
    POST
    RuleHttpMatchMethodPut
    PUT
    RuleHttpMatchMethodTrace
    TRACE
    Connect
    CONNECT
    Delete
    DELETE
    Get
    GET
    Head
    HEAD
    Options
    OPTIONS
    Post
    POST
    Put
    PUT
    Trace
    TRACE
    Connect
    CONNECT
    Delete
    DELETE
    Get
    GET
    Head
    HEAD
    Options
    OPTIONS
    Post
    POST
    Put
    PUT
    Trace
    TRACE
    CONNECT
    CONNECT
    DELETE
    DELETE
    GET
    GET
    HEAD
    HEAD
    OPTIONS
    OPTIONS
    POST
    POST
    PUT
    PUT
    TRACE
    TRACE
    "CONNECT"
    CONNECT
    "DELETE"
    DELETE
    "GET"
    GET
    "HEAD"
    HEAD
    "OPTIONS"
    OPTIONS
    "POST"
    POST
    "PUT"
    PUT
    "TRACE"
    TRACE

    RuleMatch, RuleMatchArgs

    RulePathMatch, RulePathMatchArgs

    RulePathMatchType, RulePathMatchTypeArgs

    Exact string
    Prefix string
    Exact string
    Prefix string
    exact String
    prefix String
    exact string
    prefix string
    exact str
    prefix str
    exact String
    prefix String

    RuleWeightedTargetGroup, RuleWeightedTargetGroupArgs

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi