@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
98 lines • 4.25 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Tag = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Manages an individual Transfer Family resource tag. This resource should only be used in cases where Transfer Family resources are created outside the provider (e.g., Servers without AWS Management Console) or the tag key has the `aws:` prefix.
*
* > **NOTE:** This tagging resource should not be combined with the resource for managing the parent resource. For example, using `aws.transfer.Server` and `aws.transfer.Tag` to manage tags of the same server will cause a perpetual difference where the `aws.transfer.Server` resource will try to remove the tag being added by the `aws.transfer.Tag` resource.
*
* > **NOTE:** This tagging resource does not use the provider `ignoreTags` configuration.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.transfer.Server("example", {identityProviderType: "SERVICE_MANAGED"});
* const zoneId = new aws.transfer.Tag("zone_id", {
* resourceArn: example.arn,
* key: "transfer:route53HostedZoneId",
* value: "/hostedzone/MyHostedZoneId",
* });
* const hostname = new aws.transfer.Tag("hostname", {
* resourceArn: example.arn,
* key: "transfer:customHostname",
* value: "example.com",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_transfer_tag` using the Transfer Family resource identifier and key, separated by a comma (`,`). For example:
*
* ```sh
* $ pulumi import aws:transfer/tag:Tag example arn:aws:transfer:us-east-1:123456789012:server/s-1234567890abcdef0,Name
* ```
*/
class Tag extends pulumi.CustomResource {
/**
* Get an existing Tag resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new Tag(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Tag. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Tag.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["key"] = state?.key;
resourceInputs["region"] = state?.region;
resourceInputs["resourceArn"] = state?.resourceArn;
resourceInputs["value"] = state?.value;
}
else {
const args = argsOrState;
if (args?.key === undefined && !opts.urn) {
throw new Error("Missing required property 'key'");
}
if (args?.resourceArn === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceArn'");
}
if (args?.value === undefined && !opts.urn) {
throw new Error("Missing required property 'value'");
}
resourceInputs["key"] = args?.key;
resourceInputs["region"] = args?.region;
resourceInputs["resourceArn"] = args?.resourceArn;
resourceInputs["value"] = args?.value;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Tag.__pulumiType, name, resourceInputs, opts);
}
}
exports.Tag = Tag;
/** @internal */
Tag.__pulumiType = 'aws:transfer/tag:Tag';
//# sourceMappingURL=tag.js.map