Tag class

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

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 pulumi
import pulumi_aws as aws

example = aws.transfer.Server("example", identity_provider_type="SERVICE_MANAGED")
zone_id = aws.transfer.Tag("zone_id",
    resource_arn=example.arn,
    key="transfer:route53HostedZoneId",
    value="/hostedzone/MyHostedZoneId")
hostname = aws.transfer.Tag("hostname",
    resource_arn=example.arn,
    key="transfer:customHostname",
    value="example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Transfer.Server("example", new()
    {
        IdentityProviderType = "SERVICE_MANAGED",
    });

    var zoneId = new Aws.Transfer.Tag("zone_id", new()
    {
        ResourceArn = example.Arn,
        Key = "transfer:route53HostedZoneId",
        Value = "/hostedzone/MyHostedZoneId",
    });

    var hostname = new Aws.Transfer.Tag("hostname", new()
    {
        ResourceArn = example.Arn,
        Key = "transfer:customHostname",
        Value = "example.com",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := transfer.NewServer(ctx, "example", &transfer.ServerArgs{
			IdentityProviderType: pulumi.String("SERVICE_MANAGED"),
		})
		if err != nil {
			return err
		}
		_, err = transfer.NewTag(ctx, "zone_id", &transfer.TagArgs{
			ResourceArn: example.Arn,
			Key:         pulumi.String("transfer:route53HostedZoneId"),
			Value:       pulumi.String("/hostedzone/MyHostedZoneId"),
		})
		if err != nil {
			return err
		}
		_, err = transfer.NewTag(ctx, "hostname", &transfer.TagArgs{
			ResourceArn: example.Arn,
			Key:         pulumi.String("transfer:customHostname"),
			Value:       pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_server" "example" {
  identity_provider_type = "SERVICE_MANAGED"
}
resource "aws_transfer_tag" "zone_id" {
  resource_arn = aws_transfer_server.example.arn
  key          = "transfer:route53HostedZoneId"
  value        = "/hostedzone/MyHostedZoneId"
}
resource "aws_transfer_tag" "hostname" {
  resource_arn = aws_transfer_server.example.arn
  key          = "transfer:customHostname"
  value        = "example.com"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.Server;
import com.pulumi.aws.transfer.ServerArgs;
import com.pulumi.aws.transfer.Tag;
import com.pulumi.aws.transfer.TagArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Server("example", ServerArgs.builder()
            .identityProviderType("SERVICE_MANAGED")
            .build());

        var zoneId = new Tag("zoneId", TagArgs.builder()
            .resourceArn(example.arn())
            .key("transfer:route53HostedZoneId")
            .value("/hostedzone/MyHostedZoneId")
            .build());

        var hostname = new Tag("hostname", TagArgs.builder()
            .resourceArn(example.arn())
            .key("transfer:customHostname")
            .value("example.com")
            .build());

    }
}
resources:
  example:
    type: aws:transfer:Server
    properties:
      identityProviderType: SERVICE_MANAGED
  zoneId:
    type: aws:transfer:Tag
    name: zone_id
    properties:
      resourceArn: ${example.arn}
      key: transfer:route53HostedZoneId
      value: /hostedzone/MyHostedZoneId
  hostname:
    type: aws:transfer:Tag
    properties:
      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:

$ pulumi import aws:transfer/tag:Tag example arn:aws:transfer:us-east-1:123456789012:server/s-1234567890abcdef0,Name

Constructors

Tag(String name, {TagArgs? args, CustomResourceOptions? options})
Creates a new Tag. name The Pulumi resource name. args Arguments used to configure this Tag. The set of arguments for Tag. options Resource options controlling this resource's behavior.
Tag.reference(String urn)
Creates a typed reference to an existing Tag resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
key ↔ Output<String>
Tag name.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceArn ↔ Output<String>
ARN of the Transfer Family resource to tag.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
value ↔ Output<String>
Tag value.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TagState? state, CustomResourceOptions? options}) → Tag
Gets an existing Tag resource's state with the given name and id.