1. Packages
  2. AWS Classic
  3. API Docs
  4. datasync
  5. Agent

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.datasync.Agent

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    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",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.datasync.Agent("example",
        ip_address="1.2.3.4",
        name="example")
    
    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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    resources:
      example:
        type: aws:datasync:Agent
        properties:
          ipAddress: 1.2.3.4
          name: example
    

    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.id],
        subnetIds: [exampleAwsSubnet.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.arn],
        subnetArns: [exampleAwsSubnet.arn],
        vpcEndpointId: exampleVpcEndpoint.id,
        privateLinkEndpoint: example.apply(example => example.privateIp),
        name: "example",
    });
    
    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")
    
    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, nil, nil)
    		if err != nil {
    			return err
    		}
    		exampleVpcEndpoint, err := ec2.NewVpcEndpoint(ctx, "example", &ec2.VpcEndpointArgs{
    			ServiceName: pulumi.String(fmt.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: 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
    	})
    }
    
    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",
        });
    
    });
    
    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();
    
            var exampleVpcEndpoint = new VpcEndpoint("exampleVpcEndpoint", VpcEndpointArgs.builder()
                .serviceName(String.format("com.amazonaws.%s.datasync", current.applyValue(getRegionResult -> getRegionResult.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(getNetworkInterfaceResult -> getNetworkInterfaceResult).applyValue(example -> example.applyValue(getNetworkInterfaceResult -> getNetworkInterfaceResult.privateIp())))
                .name("example")
                .build());
    
        }
    }
    
    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]}
    

    Create Agent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Agent(name: string, args?: AgentArgs, opts?: CustomResourceOptions);
    @overload
    def Agent(resource_name: str,
              args: Optional[AgentArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Agent(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              activation_key: Optional[str] = None,
              ip_address: Optional[str] = None,
              name: Optional[str] = None,
              private_link_endpoint: Optional[str] = None,
              security_group_arns: Optional[Sequence[str]] = None,
              subnet_arns: Optional[Sequence[str]] = None,
              tags: Optional[Mapping[str, str]] = None,
              vpc_endpoint_id: Optional[str] = None)
    func NewAgent(ctx *Context, name string, args *AgentArgs, opts ...ResourceOption) (*Agent, error)
    public Agent(string name, AgentArgs? args = null, CustomResourceOptions? opts = null)
    public Agent(String name, AgentArgs args)
    public Agent(String name, AgentArgs args, CustomResourceOptions options)
    
    type: aws:datasync:Agent
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var agentResource = new Aws.DataSync.Agent("agentResource", new()
    {
        ActivationKey = "string",
        IpAddress = "string",
        Name = "string",
        PrivateLinkEndpoint = "string",
        SecurityGroupArns = new[]
        {
            "string",
        },
        SubnetArns = new[]
        {
            "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        VpcEndpointId = "string",
    });
    
    example, err := datasync.NewAgent(ctx, "agentResource", &datasync.AgentArgs{
    	ActivationKey:       pulumi.String("string"),
    	IpAddress:           pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	PrivateLinkEndpoint: pulumi.String("string"),
    	SecurityGroupArns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SubnetArns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	VpcEndpointId: pulumi.String("string"),
    })
    
    var agentResource = new Agent("agentResource", AgentArgs.builder()
        .activationKey("string")
        .ipAddress("string")
        .name("string")
        .privateLinkEndpoint("string")
        .securityGroupArns("string")
        .subnetArns("string")
        .tags(Map.of("string", "string"))
        .vpcEndpointId("string")
        .build());
    
    agent_resource = aws.datasync.Agent("agentResource",
        activation_key="string",
        ip_address="string",
        name="string",
        private_link_endpoint="string",
        security_group_arns=["string"],
        subnet_arns=["string"],
        tags={
            "string": "string",
        },
        vpc_endpoint_id="string")
    
    const agentResource = new aws.datasync.Agent("agentResource", {
        activationKey: "string",
        ipAddress: "string",
        name: "string",
        privateLinkEndpoint: "string",
        securityGroupArns: ["string"],
        subnetArns: ["string"],
        tags: {
            string: "string",
        },
        vpcEndpointId: "string",
    });
    
    type: aws:datasync:Agent
    properties:
        activationKey: string
        ipAddress: string
        name: string
        privateLinkEndpoint: string
        securityGroupArns:
            - string
        subnetArns:
            - string
        tags:
            string: string
        vpcEndpointId: string
    

    Agent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Agent resource accepts the following input properties:

    ActivationKey string
    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 string
    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 string
    Name of the DataSync Agent.
    PrivateLinkEndpoint string
    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 List<string>
    The ARNs of the security groups used to protect your data transfer task subnets.
    SubnetArns List<string>
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    Tags Dictionary<string, string>
    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.
    VpcEndpointId string
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    ActivationKey string
    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 string
    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 string
    Name of the DataSync Agent.
    PrivateLinkEndpoint string
    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 []string
    The ARNs of the security groups used to protect your data transfer task subnets.
    SubnetArns []string
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    Tags map[string]string
    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.
    VpcEndpointId string
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activationKey String
    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 String
    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 String
    Name of the DataSync Agent.
    privateLinkEndpoint String
    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 List<String>
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnetArns List<String>
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags Map<String,String>
    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.
    vpcEndpointId String
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activationKey string
    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 string
    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 string
    Name of the DataSync Agent.
    privateLinkEndpoint string
    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 string[]
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnetArns string[]
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags {[key: string]: string}
    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.
    vpcEndpointId string
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activation_key str
    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.
    ip_address str
    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 str
    Name of the DataSync Agent.
    private_link_endpoint str
    The IP address of the VPC endpoint the agent should connect to when retrieving an activation key during resource creation. Conflicts with activation_key.
    security_group_arns Sequence[str]
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnet_arns Sequence[str]
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags Mapping[str, str]
    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.
    vpc_endpoint_id str
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activationKey String
    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 String
    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 String
    Name of the DataSync Agent.
    privateLinkEndpoint String
    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 List<String>
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnetArns List<String>
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags Map<String>
    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.
    vpcEndpointId String
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Agent resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the DataSync Agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the DataSync Agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the DataSync Agent.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the DataSync Agent.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the DataSync Agent.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the DataSync Agent.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Agent Resource

    Get an existing Agent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AgentState, opts?: CustomResourceOptions): Agent
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            activation_key: Optional[str] = None,
            arn: Optional[str] = None,
            ip_address: Optional[str] = None,
            name: Optional[str] = None,
            private_link_endpoint: Optional[str] = None,
            security_group_arns: Optional[Sequence[str]] = None,
            subnet_arns: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vpc_endpoint_id: Optional[str] = None) -> Agent
    func GetAgent(ctx *Context, name string, id IDInput, state *AgentState, opts ...ResourceOption) (*Agent, error)
    public static Agent Get(string name, Input<string> id, AgentState? state, CustomResourceOptions? opts = null)
    public static Agent get(String name, Output<String> id, AgentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ActivationKey string
    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.
    Arn string
    Amazon Resource Name (ARN) of the DataSync Agent.
    IpAddress string
    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 string
    Name of the DataSync Agent.
    PrivateLinkEndpoint string
    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 List<string>
    The ARNs of the security groups used to protect your data transfer task subnets.
    SubnetArns List<string>
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcEndpointId string
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    ActivationKey string
    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.
    Arn string
    Amazon Resource Name (ARN) of the DataSync Agent.
    IpAddress string
    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 string
    Name of the DataSync Agent.
    PrivateLinkEndpoint string
    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 []string
    The ARNs of the security groups used to protect your data transfer task subnets.
    SubnetArns []string
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcEndpointId string
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activationKey String
    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.
    arn String
    Amazon Resource Name (ARN) of the DataSync Agent.
    ipAddress String
    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 String
    Name of the DataSync Agent.
    privateLinkEndpoint String
    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 List<String>
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnetArns List<String>
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcEndpointId String
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activationKey string
    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.
    arn string
    Amazon Resource Name (ARN) of the DataSync Agent.
    ipAddress string
    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 string
    Name of the DataSync Agent.
    privateLinkEndpoint string
    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 string[]
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnetArns string[]
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcEndpointId string
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activation_key str
    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.
    arn str
    Amazon Resource Name (ARN) of the DataSync Agent.
    ip_address str
    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 str
    Name of the DataSync Agent.
    private_link_endpoint str
    The IP address of the VPC endpoint the agent should connect to when retrieving an activation key during resource creation. Conflicts with activation_key.
    security_group_arns Sequence[str]
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnet_arns Sequence[str]
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpc_endpoint_id str
    The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
    activationKey String
    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.
    arn String
    Amazon Resource Name (ARN) of the DataSync Agent.
    ipAddress String
    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 String
    Name of the DataSync Agent.
    privateLinkEndpoint String
    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 List<String>
    The ARNs of the security groups used to protect your data transfer task subnets.
    subnetArns List<String>
    The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

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

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi