Interface Firewall.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Firewall.Builder,Firewall>, SdkBuilder<Firewall.Builder,Firewall>, SdkPojo
Enclosing class:
Firewall
@Mutable @NotThreadSafe public static interface Firewall.Builder extends SdkPojo, CopyableBuilder<Firewall.Builder,Firewall>

  • Method Details

    • firewallName

      Firewall.Builder firewallName(String firewallName)

      The descriptive name of the firewall. You can't change the name of a firewall after you create it.

      Parameters:
      firewallName - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallArn

      Firewall.Builder firewallArn(String firewallArn)

      The Amazon Resource Name (ARN) of the firewall.

      Parameters:
      firewallArn - The Amazon Resource Name (ARN) of the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallPolicyArn

      Firewall.Builder firewallPolicyArn(String firewallPolicyArn)

      The Amazon Resource Name (ARN) of the firewall policy.

      The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

      Parameters:
      firewallPolicyArn - The Amazon Resource Name (ARN) of the firewall policy.

      The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcId

      Firewall.Builder vpcId(String vpcId)

      The unique identifier of the VPC where the firewall is in use.

      Parameters:
      vpcId - The unique identifier of the VPC where the firewall is in use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetMappings

      Firewall.Builder subnetMappings(Collection<SubnetMapping> subnetMappings)

      The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

      These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

      In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

      Parameters:
      subnetMappings - The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

      These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

      In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetMappings

      Firewall.Builder subnetMappings(SubnetMapping... subnetMappings)

      The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

      These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

      In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

      Parameters:
      subnetMappings - The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

      These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

      In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetMappings

      Firewall.Builder subnetMappings(Consumer<SubnetMapping.Builder>... subnetMappings)

      The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

      These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

      In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

      This is a convenience method that creates an instance of the SubnetMapping.Builder avoiding the need to create one manually via SubnetMapping.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subnetMappings(List<SubnetMapping>).

      Parameters:
      subnetMappings - a consumer that will call methods on SubnetMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deleteProtection

      Firewall.Builder deleteProtection(Boolean deleteProtection)

      A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

      Parameters:
      deleteProtection - A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetChangeProtection

      Firewall.Builder subnetChangeProtection(Boolean subnetChangeProtection)

      A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

      Parameters:
      subnetChangeProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallPolicyChangeProtection

      Firewall.Builder firewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection)

      A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

      Parameters:
      firewallPolicyChangeProtection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Firewall.Builder description(String description)

      A description of the firewall.

      Parameters:
      description - A description of the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallId

      Firewall.Builder firewallId(String firewallId)

      The unique identifier for the firewall.

      Parameters:
      firewallId - The unique identifier for the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Firewall.Builder tags(Collection<Tag> tags)

      Parameters:
      tags -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Firewall.Builder tags(Tag... tags)

      Parameters:
      tags -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Firewall.Builder tags(Consumer<Tag.Builder>... tags)

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionConfiguration

      Firewall.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

      Parameters:
      encryptionConfiguration - A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      default Firewall.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

      This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

      Parameters:
      encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numberOfAssociations

      Firewall.Builder numberOfAssociations(Integer numberOfAssociations)

      The number of VpcEndpointAssociation resources that use this firewall.

      Parameters:
      numberOfAssociations - The number of VpcEndpointAssociation resources that use this firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledAnalysisTypesWithStrings

      Firewall.Builder enabledAnalysisTypesWithStrings(Collection<String> enabledAnalysisTypes)

      An optional setting indicating the specific traffic analysis types to enable on the firewall.

      Parameters:
      enabledAnalysisTypes - An optional setting indicating the specific traffic analysis types to enable on the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledAnalysisTypesWithStrings

      Firewall.Builder enabledAnalysisTypesWithStrings(String... enabledAnalysisTypes)

      An optional setting indicating the specific traffic analysis types to enable on the firewall.

      Parameters:
      enabledAnalysisTypes - An optional setting indicating the specific traffic analysis types to enable on the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledAnalysisTypes

      Firewall.Builder enabledAnalysisTypes(Collection<EnabledAnalysisType> enabledAnalysisTypes)

      An optional setting indicating the specific traffic analysis types to enable on the firewall.

      Parameters:
      enabledAnalysisTypes - An optional setting indicating the specific traffic analysis types to enable on the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledAnalysisTypes

      Firewall.Builder enabledAnalysisTypes(EnabledAnalysisType... enabledAnalysisTypes)

      An optional setting indicating the specific traffic analysis types to enable on the firewall.

      Parameters:
      enabledAnalysisTypes - An optional setting indicating the specific traffic analysis types to enable on the firewall.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitGatewayId

      Firewall.Builder transitGatewayId(String transitGatewayId)

      The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.

      Parameters:
      transitGatewayId - The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitGatewayOwnerAccountId

      Firewall.Builder transitGatewayOwnerAccountId(String transitGatewayOwnerAccountId)

      The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.

      Parameters:
      transitGatewayOwnerAccountId - The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZoneMappings

      Firewall.Builder availabilityZoneMappings(Collection<AvailabilityZoneMapping> availabilityZoneMappings)

      The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.

      Parameters:
      availabilityZoneMappings - The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZoneMappings

      Firewall.Builder availabilityZoneMappings(AvailabilityZoneMapping... availabilityZoneMappings)

      The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.

      Parameters:
      availabilityZoneMappings - The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZoneMappings

      Firewall.Builder availabilityZoneMappings(Consumer<AvailabilityZoneMapping.Builder>... availabilityZoneMappings)

      The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.

      This is a convenience method that creates an instance of the AvailabilityZoneMapping.Builder avoiding the need to create one manually via AvailabilityZoneMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availabilityZoneMappings(List<AvailabilityZoneMapping>).

      Parameters:
      availabilityZoneMappings - a consumer that will call methods on AvailabilityZoneMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • availabilityZoneChangeProtection

      Firewall.Builder availabilityZoneChangeProtection(Boolean availabilityZoneChangeProtection)

      A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.

      Parameters:
      availabilityZoneChangeProtection - A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.