Interface CreateFirewallRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateFirewallRequest.Builder,
,CreateFirewallRequest> NetworkFirewallRequest.Builder
,SdkBuilder<CreateFirewallRequest.Builder,
,CreateFirewallRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateFirewallRequest
-
Method Summary
Modifier and TypeMethodDescriptionavailabilityZoneChangeProtection
(Boolean availabilityZoneChangeProtection) Optional.availabilityZoneMappings
(Collection<AvailabilityZoneMapping> availabilityZoneMappings) Required.availabilityZoneMappings
(Consumer<AvailabilityZoneMapping.Builder>... availabilityZoneMappings) Required.availabilityZoneMappings
(AvailabilityZoneMapping... availabilityZoneMappings) Required.deleteProtection
(Boolean deleteProtection) A flag indicating whether it is possible to delete the firewall.description
(String description) A description of the firewall.enabledAnalysisTypes
(Collection<EnabledAnalysisType> enabledAnalysisTypes) An optional setting indicating the specific traffic analysis types to enable on the firewall.enabledAnalysisTypes
(EnabledAnalysisType... enabledAnalysisTypes) An optional setting indicating the specific traffic analysis types to enable on the firewall.enabledAnalysisTypesWithStrings
(String... enabledAnalysisTypes) An optional setting indicating the specific traffic analysis types to enable on the firewall.enabledAnalysisTypesWithStrings
(Collection<String> enabledAnalysisTypes) An optional setting indicating the specific traffic analysis types to enable on the firewall.default CreateFirewallRequest.Builder
encryptionConfiguration
(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) A complex type that contains settings for encryption of your firewall resources.encryptionConfiguration
(EncryptionConfiguration encryptionConfiguration) A complex type that contains settings for encryption of your firewall resources.firewallName
(String firewallName) The descriptive name of the firewall.firewallPolicyArn
(String firewallPolicyArn) The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.firewallPolicyChangeProtection
(Boolean firewallPolicyChangeProtection) A setting indicating whether the firewall is protected against a change to the firewall policy association.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.subnetChangeProtection
(Boolean subnetChangeProtection) A setting indicating whether the firewall is protected against changes to the subnet associations.subnetMappings
(Collection<SubnetMapping> subnetMappings) The public subnets to use for your Network Firewall firewalls.subnetMappings
(Consumer<SubnetMapping.Builder>... subnetMappings) The public subnets to use for your Network Firewall firewalls.subnetMappings
(SubnetMapping... subnetMappings) The public subnets to use for your Network Firewall firewalls.tags
(Collection<Tag> tags) The key:value pairs to associate with the resource.tags
(Consumer<Tag.Builder>... tags) The key:value pairs to associate with the resource.The key:value pairs to associate with the resource.transitGatewayId
(String transitGatewayId) Required when creating a transit gateway-attached firewall.The unique identifier of the VPC where Network Firewall should create the firewall.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
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 theSubnetMapping.Builder
avoiding the need to create one manually viaSubnetMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosubnetMappings(List<SubnetMapping>)
.- Parameters:
subnetMappings
- a consumer that will call methods onSubnetMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toTRUE
.- Parameters:
deleteProtection
- A flag indicating whether it is possible to delete the firewall. A setting ofTRUE
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 toTRUE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toTRUE
.- 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 toTRUE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
The key:value pairs to associate with the resource.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.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 theEncryptionConfiguration.Builder
avoiding the need to create one manually viaEncryptionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionConfiguration(EncryptionConfiguration)
.- Parameters:
encryptionConfiguration
- a consumer that will call methods onEncryptionConfiguration.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
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
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
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 independence.
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 independence.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 independence.
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 independence.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 independence.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The
This is a convenience method that creates an instance of theAvailabilityZoneChangeProtection
setting controls whether you can make these modifications.AvailabilityZoneMapping.Builder
avoiding the need to create one manually viaAvailabilityZoneMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toavailabilityZoneMappings(List<AvailabilityZoneMapping>)
.- Parameters:
availabilityZoneMappings
- a consumer that will call methods onAvailabilityZoneMapping.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 toTRUE
, 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.
-
overrideConfiguration
CreateFirewallRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-