aws logo
AWS Classic v5.29.1, Feb 4 23

aws.transfer.Tag

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

Example Usage

using System.Collections.Generic;
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("zoneId", new()
    {
        ResourceArn = example.Arn,
        Key = "aws:transfer:route53HostedZoneId",
        Value = "/hostedzone/MyHostedZoneId",
    });

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

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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, "zoneId", &transfer.TagArgs{
			ResourceArn: example.Arn,
			Key:         pulumi.String("aws: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("aws:transfer:customHostname"),
			Value:       pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.List;
import java.util.ArrayList;
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("aws:transfer:route53HostedZoneId")
            .value("/hostedzone/MyHostedZoneId")
            .build());

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

    }
}
import pulumi
import pulumi_aws as aws

example = aws.transfer.Server("example", identity_provider_type="SERVICE_MANAGED")
zone_id = aws.transfer.Tag("zoneId",
    resource_arn=example.arn,
    key="aws:transfer:route53HostedZoneId",
    value="/hostedzone/MyHostedZoneId")
hostname = aws.transfer.Tag("hostname",
    resource_arn=example.arn,
    key="aws:transfer:customHostname",
    value="example.com")
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("zoneId", {
    resourceArn: example.arn,
    key: "aws:transfer:route53HostedZoneId",
    value: "/hostedzone/MyHostedZoneId",
});
const hostname = new aws.transfer.Tag("hostname", {
    resourceArn: example.arn,
    key: "aws:transfer:customHostname",
    value: "example.com",
});
resources:
  example:
    type: aws:transfer:Server
    properties:
      identityProviderType: SERVICE_MANAGED
  zoneId:
    type: aws:transfer:Tag
    properties:
      resourceArn: ${example.arn}
      key: aws:transfer:route53HostedZoneId
      value: /hostedzone/MyHostedZoneId
  hostname:
    type: aws:transfer:Tag
    properties:
      resourceArn: ${example.arn}
      key: aws:transfer:customHostname
      value: example.com

Create Tag Resource

new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);
@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        resource_arn: Optional[str] = None,
        value: Optional[str] = None)
@overload
def Tag(resource_name: str,
        args: TagArgs,
        opts: Optional[ResourceOptions] = None)
func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
public Tag(String name, TagArgs args)
public Tag(String name, TagArgs args, CustomResourceOptions options)
type: aws:transfer:Tag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TagArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Tag Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Tag resource accepts the following input properties:

Key string

Tag name.

ResourceArn string

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

Value string

Tag value.

Key string

Tag name.

ResourceArn string

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

Value string

Tag value.

key String

Tag name.

resourceArn String

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value String

Tag value.

key string

Tag name.

resourceArn string

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value string

Tag value.

key str

Tag name.

resource_arn str

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value str

Tag value.

key String

Tag name.

resourceArn String

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value String

Tag value.

Outputs

All input properties are implicitly available as output properties. Additionally, the Tag resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Tag Resource

Get an existing Tag resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TagState, opts?: CustomResourceOptions): Tag
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        resource_arn: Optional[str] = None,
        value: Optional[str] = None) -> Tag
func GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)
public static Tag Get(string name, Input<string> id, TagState? state, CustomResourceOptions? opts = null)
public static Tag get(String name, Output<String> id, TagState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Key string

Tag name.

ResourceArn string

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

Value string

Tag value.

Key string

Tag name.

ResourceArn string

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

Value string

Tag value.

key String

Tag name.

resourceArn String

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value String

Tag value.

key string

Tag name.

resourceArn string

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value string

Tag value.

key str

Tag name.

resource_arn str

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value str

Tag value.

key String

Tag name.

resourceArn String

Amazon Resource Name (ARN) of the Transfer Family resource to tag.

value String

Tag value.

Import

aws_transfer_tag can be imported by using the Transfer Family resource identifier and key, separated by a comma (,), e.g.,

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.