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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.datasync.Agent("example", {
    ipAddress: "1.2.3.4",
    name: "example",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.datasync.Agent("example",
    ip_address="1.2.3.4",
    name="example")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.DataSync.Agent("example", new()
    {
        IpAddress = "1.2.3.4",
        Name = "example",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewAgent(ctx, "example", &datasync.AgentArgs{
			IpAddress: pulumi.String("1.2.3.4"),
			Name:      pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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")
            .name("example")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:datasync:Agent
    properties:
      ipAddress: 1.2.3.4
      name: example
Content copied to clipboard

With VPC Endpoints

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const current = aws.getRegion({});
const exampleVpcEndpoint = new aws.ec2.VpcEndpoint("example", {
    serviceName: current.then(current => `com.amazonaws.${current.name}.datasync`),
    vpcId: exampleAwsVpc.id,
    securityGroupIds: [exampleAwsSecurityGroup&#46;id],
    subnetIds: [exampleAwsSubnet&#46;id],
    vpcEndpointType: "Interface",
});
const example = aws.ec2.getNetworkInterfaceOutput({
    id: exampleVpcEndpoint.networkInterfaceIds[0],
});
const exampleAgent = new aws.datasync.Agent("example", {
    ipAddress: "1.2.3.4",
    securityGroupArns: [exampleAwsSecurityGroup&#46;arn],
    subnetArns: [exampleAwsSubnet&#46;arn],
    vpcEndpointId: exampleVpcEndpoint.id,
    privateLinkEndpoint: example.apply(example => example.privateIp),
    name: "example",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
current = aws.get_region()
example_vpc_endpoint = aws.ec2.VpcEndpoint("example",
    service_name=f"com.amazonaws.{current.name}.datasync",
    vpc_id=example_aws_vpc["id"],
    security_group_ids=[example_aws_security_group["id"]],
    subnet_ids=[example_aws_subnet["id"]],
    vpc_endpoint_type="Interface")
example = aws.ec2.get_network_interface_output(id=example_vpc_endpoint.network_interface_ids[0])
example_agent = aws.datasync.Agent("example",
    ip_address="1.2.3.4",
    security_group_arns=[example_aws_security_group["arn"]],
    subnet_arns=[example_aws_subnet["arn"]],
    vpc_endpoint_id=example_vpc_endpoint.id,
    private_link_endpoint=example.private_ip,
    name="example")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var current = Aws.GetRegion.Invoke();
    var exampleVpcEndpoint = new Aws.Ec2.VpcEndpoint("example", new()
    {
        ServiceName = $"com.amazonaws.{current.Apply(getRegionResult => getRegionResult.Name)}.datasync",
        VpcId = exampleAwsVpc.Id,
        SecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        SubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        VpcEndpointType = "Interface",
    });
    var example = Aws.Ec2.GetNetworkInterface.Invoke(new()
    {
        Id = exampleVpcEndpoint.NetworkInterfaceIds[0],
    });
    var exampleAgent = new Aws.DataSync.Agent("example", new()
    {
        IpAddress = "1.2.3.4",
        SecurityGroupArns = new[]
        {
            exampleAwsSecurityGroup.Arn,
        },
        SubnetArns = new[]
        {
            exampleAwsSubnet.Arn,
        },
        VpcEndpointId = exampleVpcEndpoint.Id,
        PrivateLinkEndpoint = example.Apply(getNetworkInterfaceResult => getNetworkInterfaceResult.PrivateIp),
        Name = "example",
    });
});
Content copied to clipboard
package main
import (
	"fmt"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetRegion(ctx, &aws.GetRegionArgs{}, nil)
		if err != nil {
			return err
		}
		exampleVpcEndpoint, err := ec2.NewVpcEndpoint(ctx, "example", &ec2.VpcEndpointArgs{
			ServiceName: pulumi.Sprintf("com.amazonaws.%v.datasync", current.Name),
			VpcId:       pulumi.Any(exampleAwsVpc.Id),
			SecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			SubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			VpcEndpointType: pulumi.String("Interface"),
		})
		if err != nil {
			return err
		}
		example := ec2.LookupNetworkInterfaceOutput(ctx, ec2.GetNetworkInterfaceOutputArgs{
			Id: exampleVpcEndpoint.NetworkInterfaceIds.ApplyT(func(networkInterfaceIds []string) (string, error) {
				return networkInterfaceIds[0], nil
			}).(pulumi.StringOutput),
		}, nil)
		_, err = datasync.NewAgent(ctx, "example", &datasync.AgentArgs{
			IpAddress: pulumi.String("1.2.3.4"),
			SecurityGroupArns: pulumi.StringArray{
				exampleAwsSecurityGroup.Arn,
			},
			SubnetArns: pulumi.StringArray{
				exampleAwsSubnet.Arn,
			},
			VpcEndpointId: exampleVpcEndpoint.ID(),
			PrivateLinkEndpoint: pulumi.String(example.ApplyT(func(example ec2.GetNetworkInterfaceResult) (*string, error) {
				return &example.PrivateIp, nil
			}).(pulumi.StringPtrOutput)),
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.ec2.VpcEndpoint;
import com.pulumi.aws.ec2.VpcEndpointArgs;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetNetworkInterfaceArgs;
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) {
        final var current = AwsFunctions.getRegion(GetRegionArgs.builder()
            .build());
        var exampleVpcEndpoint = new VpcEndpoint("exampleVpcEndpoint", VpcEndpointArgs.builder()
            .serviceName(String.format("com.amazonaws.%s.datasync", current.name()))
            .vpcId(exampleAwsVpc.id())
            .securityGroupIds(exampleAwsSecurityGroup.id())
            .subnetIds(exampleAwsSubnet.id())
            .vpcEndpointType("Interface")
            .build());
        final var example = Ec2Functions.getNetworkInterface(GetNetworkInterfaceArgs.builder()
            .id(exampleVpcEndpoint.networkInterfaceIds().applyValue(_networkInterfaceIds -> _networkInterfaceIds[0]))
            .build());
        var exampleAgent = new Agent("exampleAgent", AgentArgs.builder()
            .ipAddress("1.2.3.4")
            .securityGroupArns(exampleAwsSecurityGroup.arn())
            .subnetArns(exampleAwsSubnet.arn())
            .vpcEndpointId(exampleVpcEndpoint.id())
            .privateLinkEndpoint(example.applyValue(_example -> _example.privateIp()))
            .name("example")
            .build());
    }
}
Content copied to clipboard
resources:
  exampleAgent:
    type: aws:datasync:Agent
    name: example
    properties:
      ipAddress: 1.2.3.4
      securityGroupArns:
        - ${exampleAwsSecurityGroup.arn}
      subnetArns:
        - ${exampleAwsSubnet.arn}
      vpcEndpointId: ${exampleVpcEndpoint.id}
      privateLinkEndpoint: ${example.privateIp}
      name: example
  exampleVpcEndpoint:
    type: aws:ec2:VpcEndpoint
    name: example
    properties:
      serviceName: com.amazonaws.${current.name}.datasync
      vpcId: ${exampleAwsVpc.id}
      securityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      subnetIds:
        - ${exampleAwsSubnet.id}
      vpcEndpointType: Interface
variables:
  current:
    fn::invoke:
      function: aws:getRegion
      arguments: {}
  example:
    fn::invoke:
      function: aws:ec2:getNetworkInterface
      arguments:
        id: ${exampleVpcEndpoint.networkInterfaceIds[0]}
Content copied to clipboard

Import

Using pulumi import, import aws_datasync_agent using the DataSync Agent Amazon Resource Name (ARN). For example:

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

Constructors

Link copied to clipboard
constructor(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)

Properties

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val name: Output<String>? = null

Name of the DataSync Agent.

Link copied to clipboard
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.

Link copied to clipboard
val securityGroupArns: Output<List<String>>? = null

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

Link copied to clipboard
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.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key-value pairs of resource tags to assign to the DataSync Agent. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val vpcEndpointId: Output<String>? = null

The ID of the VPC (virtual private cloud) endpoint that the agent has access to.

Functions

Link copied to clipboard
open override fun toJava(): AgentArgs