Class VpcInterfaceRequest

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.VpcInterfaceRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VpcInterfaceRequest.Builder,VpcInterfaceRequest>
@Generated("software.amazon.awssdk:codegen") public final class VpcInterfaceRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpcInterfaceRequest.Builder,VpcInterfaceRequest>

The details of the VPC interfaces that you want to add to the flow.

See Also:

  • Method Details

    • name

      public final String name()

      The name for the VPC interface. This name must be unique within the flow.

      Returns:
      The name for the VPC interface. This name must be unique within the flow.

    • networkInterfaceType

      public final NetworkInterfaceType networkInterfaceType()

      The type of network interface.

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

      Returns:
      The type of network interface.
      See Also:

    • networkInterfaceTypeAsString

      public final String networkInterfaceTypeAsString()

      The type of network interface.

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

      Returns:
      The type of network interface.
      See Also:

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.

      Returns:
      The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

    • securityGroupIds

      public final List<String> securityGroupIds()

      A virtual firewall to control inbound and outbound traffic.

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

      Returns:
      A virtual firewall to control inbound and outbound traffic.

    • subnetId

      public final String subnetId()

      The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.

      Returns:
      The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.

    • hasVpcInterfaceTags

      public final boolean hasVpcInterfaceTags()
      For responses, this returns true if the service returned a value for the VpcInterfaceTags 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.

    • vpcInterfaceTags

      public final Map<String,String> vpcInterfaceTags()

      The key-value pairs that can be used to tag and organize the VPC network interface.

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

      Returns:
      The key-value pairs that can be used to tag and organize the VPC network interface.

    • toBuilder

      public VpcInterfaceRequest.Builder 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 interface ToCopyableBuilder<VpcInterfaceRequest.Builder,VpcInterfaceRequest>
      Returns:
      a builder for type T

    • builder

      public static VpcInterfaceRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.