pulumi-aws-kotlin/com.pulumi.aws.datasync.kotlin/AgentArgs

AgentArgs

data class AgentArgs(val activationKey: Output<String>? = null, val ipAddress: Output<String>? = null, val name: Output<String>? = null, val privateLinkEndpoint: Output<String>? = null, val securityGroupArns: Output<List<String>>? = null, val subnetArns: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null, val vpcEndpointId: Output<String>? = null) : ConvertibleToJava<AgentArgs>

Manages an AWS DataSync Agent deployed on premises.

NOTE: One of activation_key or ip_address must be provided for resource creation (agent activation). Neither is required for resource import. If using ip_address, this provider must be able to make an HTTP (port 80) GET request to the specified IP address from where it is running. The agent will turn off that HTTP server after activation.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.Agent;
import com.pulumi.aws.datasync.AgentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Agent("example", AgentArgs.builder()
            .ipAddress("1.2.3.4")
            .build());
    }
}

Import

aws_datasync_agent can be imported by using the DataSync Agent Amazon Resource Name (ARN), e.g.,

$ pulumi import aws:datasync/agent:Agent example arn:aws:datasync:us-east-1:123456789012:agent/agent-12345678901234567

Constructors

AgentArgs

fun AgentArgs(activationKey: Output<String>? = null, ipAddress: Output<String>? = null, name: Output<String>? = null, privateLinkEndpoint: Output<String>? = null, securityGroupArns: Output<List<String>>? = null, subnetArns: Output<List<String>>? = null, tags: Output<Map<String, String>>? = null, vpcEndpointId: Output<String>? = null)

Functions

toJava

open override fun toJava(): AgentArgs

Properties

activationKey

val activationKey: Output<String>? = null

DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.

ipAddress

val ipAddress: Output<String>? = null

DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.

name

val name: Output<String>? = null

Name of the DataSync Agent.

privateLinkEndpoint

val privateLinkEndpoint: Output<String>? = null

The IP address of the VPC endpoint the agent should connect to when retrieving an activation key during resource creation. Conflicts with activation_key.

securityGroupArns

val securityGroupArns: Output<List<String>>? = null

The ARNs of the security groups used to protect your data transfer task subnets.

subnetArns

val subnetArns: Output<List<String>>? = null

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.