Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. appengine
  5. appengine/v1
  6. IngressRule

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.appengine/v1.IngressRule

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a firewall rule for the application. Auto-naming is currently not supported for this resource.

Create IngressRule Resource

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

Constructor syntax

new IngressRule(name: string, args: IngressRuleArgs, opts?: CustomResourceOptions);
@overload
def IngressRule(resource_name: str,
                args: IngressRuleArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def IngressRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                app_id: Optional[str] = None,
                action: Optional[IngressRuleAction] = None,
                description: Optional[str] = None,
                priority: Optional[int] = None,
                source_range: Optional[str] = None)
func NewIngressRule(ctx *Context, name string, args IngressRuleArgs, opts ...ResourceOption) (*IngressRule, error)
public IngressRule(string name, IngressRuleArgs args, CustomResourceOptions? opts = null)
public IngressRule(String name, IngressRuleArgs args)
public IngressRule(String name, IngressRuleArgs args, CustomResourceOptions options)

type: google-native:appengine/v1:IngressRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IngressRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IngressRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IngressRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IngressRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IngressRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var ingressRuleResource = new GoogleNative.AppEngine.V1.IngressRule("ingressRuleResource", new()
{
    AppId = "string",
    Action = GoogleNative.AppEngine.V1.IngressRuleAction.UnspecifiedAction,
    Description = "string",
    Priority = 0,
    SourceRange = "string",
});
Copy
example, err := appengine.NewIngressRule(ctx, "ingressRuleResource", &appengine.IngressRuleArgs{
	AppId:       pulumi.String("string"),
	Action:      appengine.IngressRuleActionUnspecifiedAction,
	Description: pulumi.String("string"),
	Priority:    pulumi.Int(0),
	SourceRange: pulumi.String("string"),
})
Copy
var ingressRuleResource = new IngressRule("ingressRuleResource", IngressRuleArgs.builder()
    .appId("string")
    .action("UNSPECIFIED_ACTION")
    .description("string")
    .priority(0)
    .sourceRange("string")
    .build());
Copy
ingress_rule_resource = google_native.appengine.v1.IngressRule("ingressRuleResource",
    app_id="string",
    action=google_native.appengine.v1.IngressRuleAction.UNSPECIFIED_ACTION,
    description="string",
    priority=0,
    source_range="string")
Copy
const ingressRuleResource = new google_native.appengine.v1.IngressRule("ingressRuleResource", {
    appId: "string",
    action: google_native.appengine.v1.IngressRuleAction.UnspecifiedAction,
    description: "string",
    priority: 0,
    sourceRange: "string",
});
Copy
type: google-native:appengine/v1:IngressRule
properties:
    action: UNSPECIFIED_ACTION
    appId: string
    description: string
    priority: 0
    sourceRange: string
Copy

IngressRule 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 IngressRule resource accepts the following input properties:

AppId
This property is required.
Changes to this property will trigger replacement.
string
Action Pulumi.GoogleNative.AppEngine.V1.IngressRuleAction
The action to take on matched requests.
Description string
An optional string description of this rule. This field has a maximum length of 400 characters.
Priority int
A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
SourceRange string
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
AppId
This property is required.
Changes to this property will trigger replacement.
string
Action IngressRuleAction
The action to take on matched requests.
Description string
An optional string description of this rule. This field has a maximum length of 400 characters.
Priority int
A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
SourceRange string
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
appId
This property is required.
Changes to this property will trigger replacement.
String
action IngressRuleAction
The action to take on matched requests.
description String
An optional string description of this rule. This field has a maximum length of 400 characters.
priority Integer
A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
sourceRange String
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
appId
This property is required.
Changes to this property will trigger replacement.
string
action IngressRuleAction
The action to take on matched requests.
description string
An optional string description of this rule. This field has a maximum length of 400 characters.
priority number
A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
sourceRange string
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
app_id
This property is required.
Changes to this property will trigger replacement.
str
action IngressRuleAction
The action to take on matched requests.
description str
An optional string description of this rule. This field has a maximum length of 400 characters.
priority int
A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
source_range str
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
appId
This property is required.
Changes to this property will trigger replacement.
String
action "UNSPECIFIED_ACTION" | "ALLOW" | "DENY"
The action to take on matched requests.
description String
An optional string description of this rule. This field has a maximum length of 400 characters.
priority Number
A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
sourceRange String
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

IngressRuleAction
, IngressRuleActionArgs

UnspecifiedAction
UNSPECIFIED_ACTION
Allow
ALLOWMatching requests are allowed.
Deny
DENYMatching requests are denied.
IngressRuleActionUnspecifiedAction
UNSPECIFIED_ACTION
IngressRuleActionAllow
ALLOWMatching requests are allowed.
IngressRuleActionDeny
DENYMatching requests are denied.
UnspecifiedAction
UNSPECIFIED_ACTION
Allow
ALLOWMatching requests are allowed.
Deny
DENYMatching requests are denied.
UnspecifiedAction
UNSPECIFIED_ACTION
Allow
ALLOWMatching requests are allowed.
Deny
DENYMatching requests are denied.
UNSPECIFIED_ACTION
UNSPECIFIED_ACTION
ALLOW
ALLOWMatching requests are allowed.
DENY
DENYMatching requests are denied.
"UNSPECIFIED_ACTION"
UNSPECIFIED_ACTION
"ALLOW"
ALLOWMatching requests are allowed.
"DENY"
DENYMatching requests are denied.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native