@Generated(value="software.amazon.awssdk:codegen") public final class CreateAgentRequest extends DataSyncRequest implements ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>
CreateAgentRequest
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateAgentRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
activationKey()
Your agent activation key.
|
String |
agentName()
The name you configured for your agent.
|
static CreateAgentRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasSecurityGroupArns()
For responses, this returns true if the service returned a value for the SecurityGroupArns property.
|
boolean |
hasSubnetArns()
For responses, this returns true if the service returned a value for the SubnetArns property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
List<SdkField<?>> |
sdkFields() |
List<String> |
securityGroupArns()
The ARNs of the security groups used to protect your data transfer task subnets.
|
static Class<? extends CreateAgentRequest.Builder> |
serializableBuilderClass() |
List<String> |
subnetArns()
The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
data transfer task.
|
List<TagListEntry> |
tags()
The key-value pair that represents the tag that you want to associate with the agent.
|
CreateAgentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
vpcEndpointId()
The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String activationKey()
Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.
The redirect URL returned in the response provides you the activation key for your agent in the query string
parameter activationKey. It might also include other activation-related parameters; however, these
are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.
For more information, see Activating an Agent in the DataSync User Guide.
The redirect URL returned in the response provides you the activation key for your agent in the query
string parameter activationKey. It might also include other activation-related parameters;
however, these are merely defaults. The arguments you pass to this API call determine the actual
configuration of your agent.
For more information, see Activating an Agent in the DataSync User Guide.
public final String agentName()
The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.
public final boolean hasTags()
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.public final List<TagListEntry> tags()
The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
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.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
public final String vpcEndpointId()
The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.
VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
public final boolean hasSubnetArns()
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.public final List<String> subnetArns()
The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.
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 hasSubnetArns() method.
public final boolean hasSecurityGroupArns()
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.public final List<String> securityGroupArns()
The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
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 hasSecurityGroupArns() method.
public CreateAgentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>toBuilder in class DataSyncRequestpublic static CreateAgentRequest.Builder builder()
public static Class<? extends CreateAgentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.