Package com.hashicorp.cdktf.providers.google.compute_firewall

Interface ComputeFirewallConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    ComputeFirewallConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:18.370Z")
@Stability(Stable)
public interface ComputeFirewallConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        Name of the resource.

        Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#name ComputeFirewall#name}

      • getNetwork

        @Stability(Stable)
@NotNull
String getNetwork()
        The name or self_link of the network to attach this firewall to.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#network ComputeFirewall#network}

      • getAllow

        @Stability(Stable)
@Nullable
default Object getAllow()
        allow block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#allow ComputeFirewall#allow}

      • getDeny

        @Stability(Stable)
@Nullable
default Object getDeny()
        deny block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#deny ComputeFirewall#deny}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        An optional description of this resource. Provide this property when you create the resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#description ComputeFirewall#description}

      • getDestinationRanges

        @Stability(Stable)
@Nullable
default List<String> getDestinationRanges()
        If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges.

        These ranges must be expressed in CIDR format. IPv4 or IPv6 ranges are supported. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#destination_ranges ComputeFirewall#destination_ranges}

      • getDirection

        @Stability(Stable)
@Nullable
default String getDirection()
        Direction of traffic to which this firewall applies;

        default is INGRESS. Note: For INGRESS traffic, one of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. Possible values: ["INGRESS", "EGRESS"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#direction ComputeFirewall#direction}

      • getDisabled

        @Stability(Stable)
@Nullable
default Object getDisabled()
        Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#disabled ComputeFirewall#disabled}

      • getEnableLogging

        @Stability(Stable)
@Nullable
default Object getEnableLogging()
        This field denotes whether to enable logging for a particular firewall rule.

        If logging is enabled, logs will be exported to Stackdriver. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#enable_logging ComputeFirewall#enable_logging}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#id ComputeFirewall#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getLogConfig

        @Stability(Stable)
@Nullable
default ComputeFirewallLogConfig getLogConfig()
        log_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#log_config ComputeFirewall#log_config}

      • getPriority

        @Stability(Stable)
@Nullable
default Number getPriority()
        Priority for this rule.

        This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#priority ComputeFirewall#priority}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#project ComputeFirewall#project}.

      • getSourceRanges

        @Stability(Stable)
@Nullable
default List<String> getSourceRanges()
        If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges.

        These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. IPv4 or IPv6 ranges are supported. For INGRESS traffic, one of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#source_ranges ComputeFirewall#source_ranges}

      • getSourceServiceAccounts

        @Stability(Stable)
@Nullable
default List<String> getSourceServiceAccounts()
        If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list.

        Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. For INGRESS traffic, one of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#source_service_accounts ComputeFirewall#source_service_accounts}

      • getSourceTags

        @Stability(Stable)
@Nullable
default List<String> getSourceTags()
        If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags.

        Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. For INGRESS traffic, one of 'source_ranges', 'source_tags' or 'source_service_accounts' is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#source_tags ComputeFirewall#source_tags}

      • getTargetServiceAccounts

        @Stability(Stable)
@Nullable
default List<String> getTargetServiceAccounts()
        A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[].

        targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#target_service_accounts ComputeFirewall#target_service_accounts}

      • getTargetTags

        @Stability(Stable)
@Nullable
default List<String> getTargetTags()
        A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[].

        If no targetTags are specified, the firewall rule applies to all instances on the specified network. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#target_tags ComputeFirewall#target_tags}

      • getTimeouts

        @Stability(Stable)
@Nullable
default ComputeFirewallTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#timeouts ComputeFirewall#timeouts}