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

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.getAgent

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.

Using getAgent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>
Copy
def get_agent(agent_arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]
Copy
func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput
Copy

> Note: This function is named LookupAgent in the Go SDK.

public static class GetAgent 
{
    public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:datasync:getAgent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AgentArn This property is required. string
The DataSync Agent ARN.
AgentArn This property is required. string
The DataSync Agent ARN.
agentArn This property is required. String
The DataSync Agent ARN.
agentArn This property is required. string
The DataSync Agent ARN.
agent_arn This property is required. str
The DataSync Agent ARN.
agentArn This property is required. String
The DataSync Agent ARN.

getAgent Result

The following output properties are available:

AgentArn string
The DataSync Agent ARN.
AgentName string
The name configured for the agent. Text reference used to identify the agent in the console.
EndpointType Pulumi.AwsNative.DataSync.AgentEndpointType
The service endpoints that the agent will connect to.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
AgentArn string
The DataSync Agent ARN.
AgentName string
The name configured for the agent. Text reference used to identify the agent in the console.
EndpointType AgentEndpointType
The service endpoints that the agent will connect to.
Tags Tag
An array of key-value pairs to apply to this resource.
agentArn String
The DataSync Agent ARN.
agentName String
The name configured for the agent. Text reference used to identify the agent in the console.
endpointType AgentEndpointType
The service endpoints that the agent will connect to.
tags List<Tag>
An array of key-value pairs to apply to this resource.
agentArn string
The DataSync Agent ARN.
agentName string
The name configured for the agent. Text reference used to identify the agent in the console.
endpointType AgentEndpointType
The service endpoints that the agent will connect to.
tags Tag[]
An array of key-value pairs to apply to this resource.
agent_arn str
The DataSync Agent ARN.
agent_name str
The name configured for the agent. Text reference used to identify the agent in the console.
endpoint_type AgentEndpointType
The service endpoints that the agent will connect to.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
agentArn String
The DataSync Agent ARN.
agentName String
The name configured for the agent. Text reference used to identify the agent in the console.
endpointType "FIPS" | "PUBLIC" | "PRIVATE_LINK"
The service endpoints that the agent will connect to.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

AgentEndpointType

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. 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