@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
104 lines (103 loc) • 2.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Data source for managing an AWS Transfer Family Connector.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.transfer.getConnector({
* id: "c-xxxxxxxxxxxxxx",
* });
* ```
*/
export declare function getConnector(args: GetConnectorArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectorResult>;
/**
* A collection of arguments for invoking getConnector.
*/
export interface GetConnectorArgs {
/**
* Unique identifier for connector
*/
id: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
}
/**
* A collection of values returned by getConnector.
*/
export interface GetConnectorResult {
/**
* ARN of the AWS Identity and Access Management role.
*/
readonly accessRole: string;
/**
* ARN of the Connector.
*/
readonly arn: string;
/**
* Structure containing the parameters for an AS2 connector object. Contains the following attributes:
*/
readonly as2Configs: outputs.transfer.GetConnectorAs2Config[];
readonly id: string;
/**
* ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
*/
readonly loggingRole: string;
readonly region: string;
/**
* Name of security policy.
*/
readonly securityPolicyName: string;
/**
* List of egress Ip addresses.
*/
readonly serviceManagedEgressIpAddresses: string[];
/**
* Object containing the following attributes:
*/
readonly sftpConfigs: outputs.transfer.GetConnectorSftpConfig[];
/**
* Object containing the following attributes:
*/
readonly tags: {
[key: string]: string;
};
/**
* URL of the partner's AS2 or SFTP endpoint.
*/
readonly url: string;
}
/**
* Data source for managing an AWS Transfer Family Connector.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.transfer.getConnector({
* id: "c-xxxxxxxxxxxxxx",
* });
* ```
*/
export declare function getConnectorOutput(args: GetConnectorOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectorResult>;
/**
* A collection of arguments for invoking getConnector.
*/
export interface GetConnectorOutputArgs {
/**
* Unique identifier for connector
*/
id: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}