Class Attachment
- java.lang.Object
-
- software.amazon.awssdk.services.networkfirewall.model.Attachment
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Attachment.Builder,Attachment>
@Generated("software.amazon.awssdk:codegen") public final class Attachment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Attachment.Builder,Attachment>
The configuration and status for a single subnet that you've specified for use by the Network Firewall firewall. This is part of the FirewallStatus.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAttachment.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Attachment.Builderbuilder()StringendpointId()The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Attachment.Builder>serializableBuilderClass()AttachmentStatusstatus()The current status of the firewall endpoint in the subnet.StringstatusAsString()The current status of the firewall endpoint in the subnet.StringstatusMessage()If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it.StringsubnetId()The unique identifier of the subnet that you've specified to be used for a firewall endpoint.Attachment.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
subnetId
public final String subnetId()
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
- Returns:
- The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
-
endpointId
public final String endpointId()
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- Returns:
- The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
-
status
public final AttachmentStatus status()
The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the
Configsettings. When this value isREADY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for exampleCREATINGorDELETING.If the service returns an enum value that is not available in the current SDK version,
statuswill returnAttachmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of
the endpoint in the VPC subnet and the sync states that are reported in the
Configsettings. When this value isREADY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for exampleCREATINGorDELETING. - See Also:
AttachmentStatus
-
statusAsString
public final String statusAsString()
The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the
Configsettings. When this value isREADY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for exampleCREATINGorDELETING.If the service returns an enum value that is not available in the current SDK version,
statuswill returnAttachmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of
the endpoint in the VPC subnet and the sync states that are reported in the
Configsettings. When this value isREADY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for exampleCREATINGorDELETING. - See Also:
AttachmentStatus
-
statusMessage
public final String statusMessage()
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A
FAILEDstatus indicates a non-recoverable state, and aERRORstatus indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.- Returns:
- If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with
the reason for the error or failure and how to resolve it. A
FAILEDstatus indicates a non-recoverable state, and aERRORstatus indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
-
toBuilder
public Attachment.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Attachment.Builder,Attachment>
-
builder
public static Attachment.Builder builder()
-
serializableBuilderClass
public static Class<? extends Attachment.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-