Class AssociateMacSecKeyRequest

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

  • Method Details

    • connectionId

      public final String connectionId()

      The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

      You can use DescribeConnections or DescribeLags to retrieve connection ID.

      Returns:
      The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

      You can use DescribeConnections or DescribeLags to retrieve connection ID.

    • secretARN

      public final String secretARN()

      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

      You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

      If you use this request parameter, you do not use the ckn and cak request parameters.

      Returns:
      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

      You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

      If you use this request parameter, you do not use the ckn and cak request parameters.

    • ckn

      public final String ckn()

      The MAC Security (MACsec) CKN to associate with the dedicated connection.

      You can create the CKN/CAK pair using an industry standard tool.

      The valid values are 64 hexadecimal characters (0-9, A-E).

      If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

      Returns:
      The MAC Security (MACsec) CKN to associate with the dedicated connection.

      You can create the CKN/CAK pair using an industry standard tool.

      The valid values are 64 hexadecimal characters (0-9, A-E).

      If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

    • cak

      public final String cak()

      The MAC Security (MACsec) CAK to associate with the dedicated connection.

      You can create the CKN/CAK pair using an industry standard tool.

      The valid values are 64 hexadecimal characters (0-9, A-E).

      If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

      Returns:
      The MAC Security (MACsec) CAK to associate with the dedicated connection.

      You can create the CKN/CAK pair using an industry standard tool.

      The valid values are 64 hexadecimal characters (0-9, A-E).

      If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

    • toBuilder

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

    • builder

      public static AssociateMacSecKeyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssociateMacSecKeyRequest.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.