Class CreateVerifiedAccessEndpointRequest

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.CreateVerifiedAccessEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateVerifiedAccessEndpointRequest.Builder,CreateVerifiedAccessEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateVerifiedAccessEndpointRequest extends Ec2Request implements ToCopyableBuilder<CreateVerifiedAccessEndpointRequest.Builder,CreateVerifiedAccessEndpointRequest>

  • Method Details

    • verifiedAccessGroupId

      public final String verifiedAccessGroupId()

      The ID of the Verified Access group to associate the endpoint with.

      Returns:
      The ID of the Verified Access group to associate the endpoint with.

    • endpointType

      public final VerifiedAccessEndpointType endpointType()

      The type of Verified Access endpoint to create.

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

      Returns:
      The type of Verified Access endpoint to create.
      See Also:

    • endpointTypeAsString

      public final String endpointTypeAsString()

      The type of Verified Access endpoint to create.

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

      Returns:
      The type of Verified Access endpoint to create.
      See Also:

    • attachmentType

      public final VerifiedAccessEndpointAttachmentType attachmentType()

      The type of attachment.

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

      Returns:
      The type of attachment.
      See Also:

    • attachmentTypeAsString

      public final String attachmentTypeAsString()

      The type of attachment.

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

      Returns:
      The type of attachment.
      See Also:

    • domainCertificateArn

      public final String domainCertificateArn()

      The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.

      Returns:
      The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.

    • applicationDomain

      public final String applicationDomain()

      The DNS name for users to reach your application.

      Returns:
      The DNS name for users to reach your application.

    • endpointDomainPrefix

      public final String endpointDomainPrefix()

      A custom identifier that is prepended to the DNS name that is generated for the endpoint.

      Returns:
      A custom identifier that is prepended to the DNS name that is generated for the endpoint.

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

      The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.

      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:
      The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.

    • loadBalancerOptions

      public final CreateVerifiedAccessEndpointLoadBalancerOptions loadBalancerOptions()

      The load balancer details. This parameter is required if the endpoint type is load-balancer.

      Returns:
      The load balancer details. This parameter is required if the endpoint type is load-balancer.

    • networkInterfaceOptions

      public final CreateVerifiedAccessEndpointEniOptions networkInterfaceOptions()

      The network interface details. This parameter is required if the endpoint type is network-interface.

      Returns:
      The network interface details. This parameter is required if the endpoint type is network-interface.

    • description

      public final String description()

      A description for the Verified Access endpoint.

      Returns:
      A description for the Verified Access endpoint.

    • policyDocument

      public final String policyDocument()

      The Verified Access policy document.

      Returns:
      The Verified Access policy document.

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

      The tags to assign to the Verified Access endpoint.

      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:
      The tags to assign to the Verified Access endpoint.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.

      Returns:
      A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.

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

    • sseSpecification

      public final VerifiedAccessSseSpecificationRequest sseSpecification()

      The options for server side encryption.

      Returns:
      The options for server side encryption.

    • toBuilder

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

    • builder

      public static CreateVerifiedAccessEndpointRequest.Builder builder()

    • serializableBuilderClass

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