Class CreateDirectConnectGatewayAttachmentRequest

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

  • Method Details

    • coreNetworkId

      public final String coreNetworkId()

      The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.

      Returns:
      The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.

    • directConnectGatewayArn

      public final String directConnectGatewayArn()

      The ARN of the Direct Connect gateway attachment.

      Returns:
      The ARN of the Direct Connect gateway attachment.

    • routingPolicyLabel

      public final String routingPolicyLabel()

      The routing policy label to apply to the Direct Connect Gateway attachment for traffic routing decisions.

      Returns:
      The routing policy label to apply to the Direct Connect Gateway attachment for traffic routing decisions.

    • hasEdgeLocations

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

    • edgeLocations

      public final List<String> edgeLocations()

      One or more core network edge locations that the Direct Connect gateway attachment is associated with.

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

      Returns:
      One or more core network edge locations that the Direct Connect gateway attachment is associated with.

    • natGatewaySupport

      public final NatGatewaySupportValue natGatewaySupport()

      Specifies whether to enable NAT gateway support on the Direct Connect gateway attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.

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

      Returns:
      Specifies whether to enable NAT gateway support on the Direct Connect gateway attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
      See Also:

    • natGatewaySupportAsString

      public final String natGatewaySupportAsString()

      Specifies whether to enable NAT gateway support on the Direct Connect gateway attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.

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

      Returns:
      Specifies whether to enable NAT gateway support on the Direct Connect gateway attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
      See Also:

    • natSystemRouteSupport

      public final Boolean natSystemRouteSupport()

      Specifies whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. System routes have a route type of SYSTEM. NAT is applied to traffic whether or not this option is enabled. The default is true.

      Returns:
      Specifies whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. System routes have a route type of SYSTEM. NAT is applied to traffic whether or not this option is enabled. The default is true.

    • hasNatGatewayRules

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

    • natGatewayRules

      public final List<NatRuleRequest> natGatewayRules()

      The NAT rules for the Direct Connect gateway attachment, up to 50 rules.

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

      Returns:
      The NAT rules for the Direct Connect gateway attachment, up to 50 rules.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The key value tags to apply to the Direct Connect gateway attachment during creation.

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

      Returns:
      The key value tags to apply to the Direct Connect gateway attachment during creation.

    • clientToken

      public final String clientToken()

      client token

      Returns:
      client token

    • toBuilder

      public CreateDirectConnectGatewayAttachmentRequest.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<CreateDirectConnectGatewayAttachmentRequest.Builder,CreateDirectConnectGatewayAttachmentRequest>
      Specified by:
      toBuilder in class NetworkManagerRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDirectConnectGatewayAttachmentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDirectConnectGatewayAttachmentRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.