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

Class ComputeFirewall.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ComputeFirewall.Builder create​(software.constructs.Construct scope,
                                             String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of ComputeFirewall.Builder.

      • connection

        @Stability(Experimental)
public ComputeFirewall.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public ComputeFirewall.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public ComputeFirewall.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public ComputeFirewall.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public ComputeFirewall.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public ComputeFirewall.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public ComputeFirewall.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public ComputeFirewall.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public ComputeFirewall.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public ComputeFirewall.Builder name​(String name)
        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}

        Parameters:
        name - Name of the resource. This parameter is required.
        Returns:
        this

      • network

        @Stability(Stable)
public ComputeFirewall.Builder network​(String network)
        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}

        Parameters:
        network - The name or self_link of the network to attach this firewall to. This parameter is required.
        Returns:
        this

      • allow

        @Stability(Stable)
public ComputeFirewall.Builder allow​(com.hashicorp.cdktf.IResolvable allow)
        allow block.

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

        Parameters:
        allow - allow block. This parameter is required.
        Returns:
        this

      • allow

        @Stability(Stable)
public ComputeFirewall.Builder allow​(List<? extends ComputeFirewallAllow> allow)
        allow block.

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

        Parameters:
        allow - allow block. This parameter is required.
        Returns:
        this

      • deny

        @Stability(Stable)
public ComputeFirewall.Builder deny​(com.hashicorp.cdktf.IResolvable deny)
        deny block.

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

        Parameters:
        deny - deny block. This parameter is required.
        Returns:
        this

      • deny

        @Stability(Stable)
public ComputeFirewall.Builder deny​(List<? extends ComputeFirewallDeny> deny)
        deny block.

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

        Parameters:
        deny - deny block. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public ComputeFirewall.Builder description​(String description)
        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}

        Parameters:
        description - An optional description of this resource. Provide this property when you create the resource. This parameter is required.
        Returns:
        this

      • destinationRanges

        @Stability(Stable)
public ComputeFirewall.Builder destinationRanges​(List<String> destinationRanges)
        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}

        Parameters:
        destinationRanges - If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. This parameter is required.
        Returns:
        this

      • direction

        @Stability(Stable)
public ComputeFirewall.Builder direction​(String direction)
        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}

        Parameters:
        direction - Direction of traffic to which this firewall applies;. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public ComputeFirewall.Builder disabled​(Boolean disabled)
        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}

        Parameters:
        disabled - 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. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public ComputeFirewall.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        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}

        Parameters:
        disabled - 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. This parameter is required.
        Returns:
        this

      • enableLogging

        @Stability(Stable)
public ComputeFirewall.Builder enableLogging​(Boolean enableLogging)
        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}

        Parameters:
        enableLogging - This field denotes whether to enable logging for a particular firewall rule. This parameter is required.
        Returns:
        this

      • enableLogging

        @Stability(Stable)
public ComputeFirewall.Builder enableLogging​(com.hashicorp.cdktf.IResolvable enableLogging)
        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}

        Parameters:
        enableLogging - This field denotes whether to enable logging for a particular firewall rule. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ComputeFirewall.Builder id​(String id)
        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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#id ComputeFirewall#id}. This parameter is required.
        Returns:
        this

      • logConfig

        @Stability(Stable)
public ComputeFirewall.Builder logConfig​(ComputeFirewallLogConfig logConfig)
        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}

        Parameters:
        logConfig - log_config block. This parameter is required.
        Returns:
        this

      • priority

        @Stability(Stable)
public ComputeFirewall.Builder priority​(Number priority)
        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}

        Parameters:
        priority - Priority for this rule. This parameter is required.
        Returns:
        this

      • project

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

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_firewall#project ComputeFirewall#project}. This parameter is required.
        Returns:
        this

      • sourceRanges

        @Stability(Stable)
public ComputeFirewall.Builder sourceRanges​(List<String> sourceRanges)
        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}

        Parameters:
        sourceRanges - If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. This parameter is required.
        Returns:
        this

      • sourceServiceAccounts

        @Stability(Stable)
public ComputeFirewall.Builder sourceServiceAccounts​(List<String> sourceServiceAccounts)
        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}

        Parameters:
        sourceServiceAccounts - If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. This parameter is required.
        Returns:
        this

      • sourceTags

        @Stability(Stable)
public ComputeFirewall.Builder sourceTags​(List<String> sourceTags)
        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}

        Parameters:
        sourceTags - If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. This parameter is required.
        Returns:
        this

      • targetServiceAccounts

        @Stability(Stable)
public ComputeFirewall.Builder targetServiceAccounts​(List<String> targetServiceAccounts)
        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}

        Parameters:
        targetServiceAccounts - A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. This parameter is required.
        Returns:
        this

      • targetTags

        @Stability(Stable)
public ComputeFirewall.Builder targetTags​(List<String> targetTags)
        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}

        Parameters:
        targetTags - A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ComputeFirewall.Builder timeouts​(ComputeFirewallTimeouts timeouts)
        timeouts block.

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

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this