Interface CreateFirewallRequest.Builder

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

  • Method Details

    • firewallName

      CreateFirewallRequest.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.

    • firewallPolicyArn

      CreateFirewallRequest.Builder firewallPolicyArn(String firewallPolicyArn)

      The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

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

    • vpcId

      CreateFirewallRequest.Builder vpcId(String vpcId)

      The unique identifier of the VPC where Network Firewall should create the firewall.

      You can't change this setting after you create the firewall.

      Parameters:
      vpcId - The unique identifier of the VPC where Network Firewall should create the firewall.

      You can't change this setting after you create the firewall.

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

    • subnetMappings

      CreateFirewallRequest.Builder subnetMappings(Collection<SubnetMapping> subnetMappings)

      The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

      Parameters:
      subnetMappings - The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetMappings

      CreateFirewallRequest.Builder subnetMappings(SubnetMapping... subnetMappings)

      The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

      Parameters:
      subnetMappings - The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetMappings

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

      The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

      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

      CreateFirewallRequest.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

      CreateFirewallRequest.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

      CreateFirewallRequest.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

      CreateFirewallRequest.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.

    • tags

      CreateFirewallRequest.Builder tags(Collection<Tag> tags)

      The key:value pairs to associate with the resource.

      Parameters:
      tags - The key:value pairs to associate with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFirewallRequest.Builder tags(Tag... tags)

      The key:value pairs to associate with the resource.

      Parameters:
      tags - The key:value pairs to associate with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      The key:value pairs to associate with the resource.

      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

      CreateFirewallRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

      A complex type that contains settings for encryption of your firewall resources.

      Parameters:
      encryptionConfiguration - A complex type that contains settings for encryption of your firewall resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

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

      A complex type that contains settings for encryption of your firewall resources.

      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:

    • enabledAnalysisTypesWithStrings

      CreateFirewallRequest.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

      CreateFirewallRequest.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

      CreateFirewallRequest.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

      CreateFirewallRequest.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

      CreateFirewallRequest.Builder transitGatewayId(String transitGatewayId)

      Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.

      After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.

      For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.

      Parameters:
      transitGatewayId - Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.

      After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.

      For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.

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

    • availabilityZoneMappings

      CreateFirewallRequest.Builder availabilityZoneMappings(Collection<AvailabilityZoneMapping> availabilityZoneMappings)

      Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

      You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

      Parameters:
      availabilityZoneMappings - Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

      You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

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

    • availabilityZoneMappings

      CreateFirewallRequest.Builder availabilityZoneMappings(AvailabilityZoneMapping... availabilityZoneMappings)

      Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

      You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

      Parameters:
      availabilityZoneMappings - Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

      You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

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

    • availabilityZoneMappings

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

      Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

      You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

      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

      CreateFirewallRequest.Builder availabilityZoneChangeProtection(Boolean availabilityZoneChangeProtection)

      Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.

      Default value: FALSE

      Parameters:
      availabilityZoneChangeProtection - Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.

      Default value: FALSE

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

    • natGatewayMappings

      CreateFirewallRequest.Builder natGatewayMappings(Collection<NatGatewayMapping> natGatewayMappings)

      The NAT gateways that the firewall uses to proxy traffic when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway.

      Parameters:
      natGatewayMappings - The NAT gateways that the firewall uses to proxy traffic when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • natGatewayMappings

      CreateFirewallRequest.Builder natGatewayMappings(NatGatewayMapping... natGatewayMappings)

      The NAT gateways that the firewall uses to proxy traffic when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway.

      Parameters:
      natGatewayMappings - The NAT gateways that the firewall uses to proxy traffic when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • natGatewayMappings

      CreateFirewallRequest.Builder natGatewayMappings(Consumer<NatGatewayMapping.Builder>... natGatewayMappings)

      The NAT gateways that the firewall uses to proxy traffic when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway.

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

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

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

    • proxySettings

      CreateFirewallRequest.Builder proxySettings(ProxySettings proxySettings)

      The listener configuration for a proxy mode firewall, used when NoSourcePreservation is TRUE. This specifies the ports and protocols on which the firewall's proxy listens for traffic.

      Parameters:
      proxySettings - The listener configuration for a proxy mode firewall, used when NoSourcePreservation is TRUE. This specifies the ports and protocols on which the firewall's proxy listens for traffic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proxySettings

      default CreateFirewallRequest.Builder proxySettings(Consumer<ProxySettings.Builder> proxySettings)

      The listener configuration for a proxy mode firewall, used when NoSourcePreservation is TRUE. This specifies the ports and protocols on which the firewall's proxy listens for traffic.

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

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

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

    • noSourcePreservation

      CreateFirewallRequest.Builder noSourcePreservation(Boolean noSourcePreservation)

      Optional. Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When set to TRUE, the firewall proxies traffic through a NAT gateway and the traffic reaching the destination uses the NAT gateway's IP address as the source.

      When you set this to TRUE, you must specify NatGatewayMappings and VpcEndpoint instead of a top-level VpcId and SubnetMappings.

      You can't change this setting after you create the firewall.

      Default value: FALSE

      Parameters:
      noSourcePreservation - Optional. Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When set to TRUE, the firewall proxies traffic through a NAT gateway and the traffic reaching the destination uses the NAT gateway's IP address as the source.

      When you set this to TRUE, you must specify NatGatewayMappings and VpcEndpoint instead of a top-level VpcId and SubnetMappings.

      You can't change this setting after you create the firewall.

      Default value: FALSE

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

    • vpcEndpoint

      CreateFirewallRequest.Builder vpcEndpoint(VpcEndpoint vpcEndpoint)

      The VPC and subnets for the firewall endpoint, used when NoSourcePreservation is TRUE. Network Firewall creates the firewall endpoint in the subnets that you specify here.

      For proxy mode firewalls, provide the firewall's VPC and endpoint subnets through this parameter instead of the top-level VpcId and SubnetMappings.

      Parameters:
      vpcEndpoint - The VPC and subnets for the firewall endpoint, used when NoSourcePreservation is TRUE. Network Firewall creates the firewall endpoint in the subnets that you specify here.

      For proxy mode firewalls, provide the firewall's VPC and endpoint subnets through this parameter instead of the top-level VpcId and SubnetMappings.

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

    • vpcEndpoint

      default CreateFirewallRequest.Builder vpcEndpoint(Consumer<VpcEndpoint.Builder> vpcEndpoint)

      The VPC and subnets for the firewall endpoint, used when NoSourcePreservation is TRUE. Network Firewall creates the firewall endpoint in the subnets that you specify here.

      For proxy mode firewalls, provide the firewall's VPC and endpoint subnets through this parameter instead of the top-level VpcId and SubnetMappings.

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

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

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

    • overrideConfiguration

      CreateFirewallRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateFirewallRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.