@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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
boolean |
hasSecurityGroupArns()
Returns true if the SecurityGroupArns property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasSubnetArns()
Returns true if the SubnetArns property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
overrideConfigurationcopypublic 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 AWS 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 AWS 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 AWS 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()
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.
You can use hasTags() to see if a value was sent in this field.
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()
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.
You can use hasSubnetArns() to see if a value was sent in this field.
public final boolean hasSecurityGroupArns()
public final List<String> securityGroupArns()
The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecurityGroupArns() to see if a value was sent in this field.
public CreateAgentRequest.Builder toBuilder()
ToCopyableBuildertoBuilder 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)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.