Class CreateVerifiedAccessEndpointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateVerifiedAccessEndpointRequest.Builder,
CreateVerifiedAccessEndpointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The DNS name for users to reach your application.The type of attachment.final String
The type of attachment.builder()
final String
A unique, case-sensitive token that you provide to ensure idempotency of your modification request.final String
A description for the Verified Access endpoint.final String
The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final String
A custom identifier that is prepended to the DNS name that is generated for the endpoint.The type of Verified Access endpoint to create.final String
The type of Verified Access endpoint to create.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.The load balancer details.The network interface details.final String
The Verified Access policy document.The IDs of the security groups to associate with the Verified Access endpoint.static Class
<? extends CreateVerifiedAccessEndpointRequest.Builder> The options for server side encryption.final List
<TagSpecification> The tags to assign to the Verified Access endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the Verified Access group to associate the endpoint with.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnVerifiedAccessEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The type of Verified Access endpoint to create.
- See Also:
-
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 returnVerifiedAccessEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The type of Verified Access endpoint to create.
- See Also:
-
attachmentType
The type of attachment.
If the service returns an enum value that is not available in the current SDK version,
attachmentType
will returnVerifiedAccessEndpointAttachmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattachmentTypeAsString()
.- Returns:
- The type of attachment.
- See Also:
-
attachmentTypeAsString
The type of attachment.
If the service returns an enum value that is not available in the current SDK version,
attachmentType
will returnVerifiedAccessEndpointAttachmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattachmentTypeAsString()
.- Returns:
- The type of attachment.
- See Also:
-
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
The DNS name for users to reach your application.
- Returns:
- The DNS name for users to reach your application.
-
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 theisEmpty()
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
The IDs of the security groups to associate with the Verified Access endpoint. Required if
AttachmentType
is set tovpc
.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 tovpc
.
-
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
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
A description for the Verified Access endpoint.
- Returns:
- A description for the Verified Access endpoint.
-
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 theisEmpty()
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
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
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
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
sseSpecification
The options for server side encryption.
- Returns:
- The options for server side encryption.
-
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 interfaceToCopyableBuilder<CreateVerifiedAccessEndpointRequest.Builder,
CreateVerifiedAccessEndpointRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateVerifiedAccessEndpointRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-