Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datasync
  5. Agent

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.datasync.Agent

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::DataSync::Agent.

Example Usage

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var agent = new AwsNative.DataSync.Agent("agent", new()
    {
        ActivationKey = "AAAAA-7AAAA-GG7MC-3I9R3-27COD",
        AgentName = "MyAgent",
    });

});
Copy
package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewAgent(ctx, "agent", &datasync.AgentArgs{
			ActivationKey: pulumi.String("AAAAA-7AAAA-GG7MC-3I9R3-27COD"),
			AgentName:     pulumi.String("MyAgent"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const agent = new aws_native.datasync.Agent("agent", {
    activationKey: "AAAAA-7AAAA-GG7MC-3I9R3-27COD",
    agentName: "MyAgent",
});
Copy
import pulumi
import pulumi_aws_native as aws_native

agent = aws_native.datasync.Agent("agent",
    activation_key="AAAAA-7AAAA-GG7MC-3I9R3-27COD",
    agent_name="MyAgent")
Copy

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var agent = new AwsNative.DataSync.Agent("agent", new()
    {
        ActivationKey = "AAAAA-7AAAA-GG7MC-3I9R3-27COD",
        AgentName = "MyAgent",
    });

});
Copy
package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewAgent(ctx, "agent", &datasync.AgentArgs{
			ActivationKey: pulumi.String("AAAAA-7AAAA-GG7MC-3I9R3-27COD"),
			AgentName:     pulumi.String("MyAgent"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const agent = new aws_native.datasync.Agent("agent", {
    activationKey: "AAAAA-7AAAA-GG7MC-3I9R3-27COD",
    agentName: "MyAgent",
});
Copy
import pulumi
import pulumi_aws_native as aws_native

agent = aws_native.datasync.Agent("agent",
    activation_key="AAAAA-7AAAA-GG7MC-3I9R3-27COD",
    agent_name="MyAgent")
Copy

Coming soon!

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,
          agent_name: Optional[str] = None,
          security_group_arns: Optional[Sequence[str]] = None,
          subnet_arns: Optional[Sequence[str]] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:datasync:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. AgentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Agent resource accepts the following input properties:

ActivationKey string
Activation key of the Agent.
AgentName string
The name configured for the agent. Text reference used to identify the agent in the console.
SecurityGroupArns List<string>
The ARNs of the security group used to protect your data transfer task subnets.
SubnetArns List<string>
The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
VpcEndpointId string
The ID of the VPC endpoint that the agent has access to.
ActivationKey string
Activation key of the Agent.
AgentName string
The name configured for the agent. Text reference used to identify the agent in the console.
SecurityGroupArns []string
The ARNs of the security group used to protect your data transfer task subnets.
SubnetArns []string
The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
Tags TagArgs
An array of key-value pairs to apply to this resource.
VpcEndpointId string
The ID of the VPC endpoint that the agent has access to.
activationKey String
Activation key of the Agent.
agentName String
The name configured for the agent. Text reference used to identify the agent in the console.
securityGroupArns List<String>
The ARNs of the security group used to protect your data transfer task subnets.
subnetArns List<String>
The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
tags List<Tag>
An array of key-value pairs to apply to this resource.
vpcEndpointId String
The ID of the VPC endpoint that the agent has access to.
activationKey string
Activation key of the Agent.
agentName string
The name configured for the agent. Text reference used to identify the agent in the console.
securityGroupArns string[]
The ARNs of the security group used to protect your data transfer task subnets.
subnetArns string[]
The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
tags Tag[]
An array of key-value pairs to apply to this resource.
vpcEndpointId string
The ID of the VPC endpoint that the agent has access to.
activation_key str
Activation key of the Agent.
agent_name str
The name configured for the agent. Text reference used to identify the agent in the console.
security_group_arns Sequence[str]
The ARNs of the security group used to protect your data transfer task subnets.
subnet_arns Sequence[str]
The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
vpc_endpoint_id str
The ID of the VPC endpoint that the agent has access to.
activationKey String
Activation key of the Agent.
agentName String
The name configured for the agent. Text reference used to identify the agent in the console.
securityGroupArns List<String>
The ARNs of the security group used to protect your data transfer task subnets.
subnetArns List<String>
The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
vpcEndpointId String
The ID of the VPC 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:

AgentArn string
The DataSync Agent ARN.
EndpointType Pulumi.AwsNative.DataSync.AgentEndpointType
The service endpoints that the agent will connect to.
Id string
The provider-assigned unique ID for this managed resource.
AgentArn string
The DataSync Agent ARN.
EndpointType AgentEndpointType
The service endpoints that the agent will connect to.
Id string
The provider-assigned unique ID for this managed resource.
agentArn String
The DataSync Agent ARN.
endpointType AgentEndpointType
The service endpoints that the agent will connect to.
id String
The provider-assigned unique ID for this managed resource.
agentArn string
The DataSync Agent ARN.
endpointType AgentEndpointType
The service endpoints that the agent will connect to.
id string
The provider-assigned unique ID for this managed resource.
agent_arn str
The DataSync Agent ARN.
endpoint_type AgentEndpointType
The service endpoints that the agent will connect to.
id str
The provider-assigned unique ID for this managed resource.
agentArn String
The DataSync Agent ARN.
endpointType "FIPS" | "PUBLIC" | "PRIVATE_LINK"
The service endpoints that the agent will connect to.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

AgentEndpointType
, AgentEndpointTypeArgs

Fips
FIPS
Public
PUBLIC
PrivateLink
PRIVATE_LINK
AgentEndpointTypeFips
FIPS
AgentEndpointTypePublic
PUBLIC
AgentEndpointTypePrivateLink
PRIVATE_LINK
Fips
FIPS
Public
PUBLIC
PrivateLink
PRIVATE_LINK
Fips
FIPS
Public
PUBLIC
PrivateLink
PRIVATE_LINK
FIPS
FIPS
PUBLIC
PUBLIC
PRIVATE_LINK
PRIVATE_LINK
"FIPS"
FIPS
"PUBLIC"
PUBLIC
"PRIVATE_LINK"
PRIVATE_LINK

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native