Package software.amazon.awssdk.services.ec2.model

Class CreateTrafficMirrorFilterRuleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.CreateTrafficMirrorFilterRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTrafficMirrorFilterRuleRequest.Builder,CreateTrafficMirrorFilterRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTrafficMirrorFilterRuleRequest extends Ec2Request implements ToCopyableBuilder<CreateTrafficMirrorFilterRuleRequest.Builder,CreateTrafficMirrorFilterRuleRequest>

  • Method Details

    • trafficMirrorFilterId

      public final String trafficMirrorFilterId()

      The ID of the filter that this rule is associated with.

      Returns:
      The ID of the filter that this rule is associated with.

    • trafficDirection

      public final TrafficDirection trafficDirection()

      The type of traffic.

      If the service returns an enum value that is not available in the current SDK version, trafficDirection will return TrafficDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficDirectionAsString().

      Returns:
      The type of traffic.
      See Also:

    • trafficDirectionAsString

      public final String trafficDirectionAsString()

      The type of traffic.

      If the service returns an enum value that is not available in the current SDK version, trafficDirection will return TrafficDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficDirectionAsString().

      Returns:
      The type of traffic.
      See Also:

    • ruleNumber

      public final Integer ruleNumber()

      The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

      Returns:
      The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

    • ruleAction

      public final TrafficMirrorRuleAction ruleAction()

      The action to take on the filtered traffic.

      If the service returns an enum value that is not available in the current SDK version, ruleAction will return TrafficMirrorRuleAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleActionAsString().

      Returns:
      The action to take on the filtered traffic.
      See Also:

    • ruleActionAsString

      public final String ruleActionAsString()

      The action to take on the filtered traffic.

      If the service returns an enum value that is not available in the current SDK version, ruleAction will return TrafficMirrorRuleAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleActionAsString().

      Returns:
      The action to take on the filtered traffic.
      See Also:

    • destinationPortRange

      public final TrafficMirrorPortRangeRequest destinationPortRange()

      The destination port range.

      Returns:
      The destination port range.

    • sourcePortRange

      public final TrafficMirrorPortRangeRequest sourcePortRange()

      The source port range.

      Returns:
      The source port range.

    • protocol

      public final Integer protocol()

      The protocol, for example UDP, to assign to the Traffic Mirror rule.

      For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

      Returns:
      The protocol, for example UDP, to assign to the Traffic Mirror rule.

      For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

    • destinationCidrBlock

      public final String destinationCidrBlock()

      The destination CIDR block to assign to the Traffic Mirror rule.

      Returns:
      The destination CIDR block to assign to the Traffic Mirror rule.

    • sourceCidrBlock

      public final String sourceCidrBlock()

      The source CIDR block to assign to the Traffic Mirror rule.

      Returns:
      The source CIDR block to assign to the Traffic Mirror rule.

    • description

      public final String description()

      The description of the Traffic Mirror rule.

      Returns:
      The description of the Traffic Mirror rule.

    • dryRun

      public final Boolean 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 is UnauthorizedOperation.

      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 is UnauthorizedOperation.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      Traffic Mirroring tags specifications.

      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 hasTagSpecifications() method.

      Returns:
      Traffic Mirroring tags specifications.

    • toBuilder

      public CreateTrafficMirrorFilterRuleRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTrafficMirrorFilterRuleRequest.Builder,CreateTrafficMirrorFilterRuleRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static CreateTrafficMirrorFilterRuleRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTrafficMirrorFilterRuleRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo