Interface CreateAgentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAgentRequest.Builder,
,CreateAgentRequest> DataSyncRequest.Builder
,SdkBuilder<CreateAgentRequest.Builder,
,CreateAgentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAgentRequest
-
Method Summary
Modifier and TypeMethodDescriptionactivationKey
(String activationKey) Specifies your DataSync agent's activation key.Specifies a name for your agent.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.securityGroupArns
(String... securityGroupArns) Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint.securityGroupArns
(Collection<String> securityGroupArns) Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint.subnetArns
(String... subnetArns) Specifies the ARN of the subnet where your VPC service endpoint is located.subnetArns
(Collection<String> subnetArns) Specifies the ARN of the subnet where your VPC service endpoint is located.tags
(Collection<TagListEntry> tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.tags
(Consumer<TagListEntry.Builder>... tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.tags
(TagListEntry... tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.vpcEndpointId
(String vpcEndpointId) Specifies the ID of the VPC service endpoint that you're using.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
activationKey
Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent.
- Parameters:
activationKey
- Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentName
Specifies a name for your agent. We recommend specifying a name that you can remember.
- Parameters:
agentName
- Specifies a name for your agent. We recommend specifying a name that you can remember.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.
- Parameters:
tags
- Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.
- Parameters:
tags
- Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.
This is a convenience method that creates an instance of theTagListEntry.Builder
avoiding the need to create one manually viaTagListEntry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<TagListEntry>)
.- Parameters:
tags
- a consumer that will call methods onTagListEntry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcEndpointId
Specifies the ID of the VPC service endpoint that you're using. For example, a VPC endpoint ID looks like
vpce-01234d5aff67890e1
.The VPC service endpoint you use must include the DataSync service name (for example,
com.amazonaws.us-east-2.datasync
).- Parameters:
vpcEndpointId
- Specifies the ID of the VPC service endpoint that you're using. For example, a VPC endpoint ID looks likevpce-01234d5aff67890e1
.The VPC service endpoint you use must include the DataSync service name (for example,
com.amazonaws.us-east-2.datasync
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetArns
Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.
- Parameters:
subnetArns
- Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetArns
Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.
- Parameters:
subnetArns
- Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupArns
Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.
- Parameters:
securityGroupArns
- Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupArns
Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.
- Parameters:
securityGroupArns
- Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-