Class ModifyTrafficMirrorSessionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyTrafficMirrorSessionRequest.Builder,
ModifyTrafficMirrorSessionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The description to assign to the Traffic Mirror session.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RemoveFields property.final Integer
The number of bytes in each packet to mirror.final List
<TrafficMirrorSessionField> The properties that you want to remove from the Traffic Mirror session.The properties that you want to remove from the Traffic Mirror session.static Class
<? extends ModifyTrafficMirrorSessionRequest.Builder> final Integer
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the Traffic Mirror filter.final String
The ID of the Traffic Mirror session.final String
The Traffic Mirror target.final Integer
The virtual network ID of the Traffic Mirror session.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
trafficMirrorSessionId
The ID of the Traffic Mirror session.
- Returns:
- The ID of the Traffic Mirror session.
-
trafficMirrorTargetId
The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
- Returns:
- The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
-
trafficMirrorFilterId
The ID of the Traffic Mirror filter.
- Returns:
- The ID of the Traffic Mirror filter.
-
packetLength
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
For sessions with Network Load Balancer (NLB) traffic mirror targets, the default
PacketLength
will be set to 8500. Valid values are 1-8500. Setting aPacketLength
greater than 8500 will result in an error response.- Returns:
- The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset,
set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first
100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you
want to mirror the entire packet.
For sessions with Network Load Balancer (NLB) traffic mirror targets, the default
PacketLength
will be set to 8500. Valid values are 1-8500. Setting aPacketLength
greater than 8500 will result in an error response.
-
sessionNumber
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
- Returns:
- The session number determines the order in which sessions are evaluated when an interface is used by
multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
-
virtualNetworkId
The virtual network ID of the Traffic Mirror session.
- Returns:
- The virtual network ID of the Traffic Mirror session.
-
description
The description to assign to the Traffic Mirror session.
- Returns:
- The description to assign to the Traffic Mirror session.
-
removeFields
The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRemoveFields()
method.- Returns:
- The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
-
hasRemoveFields
public final boolean hasRemoveFields()For responses, this returns true if the service returned a value for the RemoveFields property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
removeFieldsAsStrings
The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRemoveFields()
method.- Returns:
- The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
-
dryRun
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyTrafficMirrorSessionRequest.Builder,
ModifyTrafficMirrorSessionRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-