1. Packages
  2. AWS
  3. API Docs
  4. storagegateway
  5. Gateway
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.storagegateway.Gateway

Explore with Pulumi AI

Manages an AWS Storage Gateway file, tape, or volume gateway in the provider region.

NOTE: The Storage Gateway API requires the gateway to be connected to properly return information after activation. If you are receiving The specified gateway is not connected errors during resource creation (gateway activation), ensure your gateway instance meets the Storage Gateway requirements.

Example Usage

Local Cache

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testVolumeAttachment = new aws.ec2.VolumeAttachment("test", {
    deviceName: "/dev/xvdb",
    volumeId: testAwsEbsVolume.id,
    instanceId: testAwsInstance.id,
});
const test = aws.storagegateway.getLocalDisk({
    diskNode: testAwsVolumeAttachment.deviceName,
    gatewayArn: testAwsStoragegatewayGateway.arn,
});
const testCache = new aws.storagegateway.Cache("test", {
    diskId: test.then(test => test.diskId),
    gatewayArn: testAwsStoragegatewayGateway.arn,
});
Copy
import pulumi
import pulumi_aws as aws

test_volume_attachment = aws.ec2.VolumeAttachment("test",
    device_name="/dev/xvdb",
    volume_id=test_aws_ebs_volume["id"],
    instance_id=test_aws_instance["id"])
test = aws.storagegateway.get_local_disk(disk_node=test_aws_volume_attachment["deviceName"],
    gateway_arn=test_aws_storagegateway_gateway["arn"])
test_cache = aws.storagegateway.Cache("test",
    disk_id=test.disk_id,
    gateway_arn=test_aws_storagegateway_gateway["arn"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewVolumeAttachment(ctx, "test", &ec2.VolumeAttachmentArgs{
			DeviceName: pulumi.String("/dev/xvdb"),
			VolumeId:   pulumi.Any(testAwsEbsVolume.Id),
			InstanceId: pulumi.Any(testAwsInstance.Id),
		})
		if err != nil {
			return err
		}
		test, err := storagegateway.GetLocalDisk(ctx, &storagegateway.GetLocalDiskArgs{
			DiskNode:   pulumi.StringRef(testAwsVolumeAttachment.DeviceName),
			GatewayArn: testAwsStoragegatewayGateway.Arn,
		}, nil)
		if err != nil {
			return err
		}
		_, err = storagegateway.NewCache(ctx, "test", &storagegateway.CacheArgs{
			DiskId:     pulumi.String(test.DiskId),
			GatewayArn: pulumi.Any(testAwsStoragegatewayGateway.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testVolumeAttachment = new Aws.Ec2.VolumeAttachment("test", new()
    {
        DeviceName = "/dev/xvdb",
        VolumeId = testAwsEbsVolume.Id,
        InstanceId = testAwsInstance.Id,
    });

    var test = Aws.StorageGateway.GetLocalDisk.Invoke(new()
    {
        DiskNode = testAwsVolumeAttachment.DeviceName,
        GatewayArn = testAwsStoragegatewayGateway.Arn,
    });

    var testCache = new Aws.StorageGateway.Cache("test", new()
    {
        DiskId = test.Apply(getLocalDiskResult => getLocalDiskResult.DiskId),
        GatewayArn = testAwsStoragegatewayGateway.Arn,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VolumeAttachment;
import com.pulumi.aws.ec2.VolumeAttachmentArgs;
import com.pulumi.aws.storagegateway.StoragegatewayFunctions;
import com.pulumi.aws.storagegateway.inputs.GetLocalDiskArgs;
import com.pulumi.aws.storagegateway.Cache;
import com.pulumi.aws.storagegateway.CacheArgs;
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 testVolumeAttachment = new VolumeAttachment("testVolumeAttachment", VolumeAttachmentArgs.builder()
            .deviceName("/dev/xvdb")
            .volumeId(testAwsEbsVolume.id())
            .instanceId(testAwsInstance.id())
            .build());

        final var test = StoragegatewayFunctions.getLocalDisk(GetLocalDiskArgs.builder()
            .diskNode(testAwsVolumeAttachment.deviceName())
            .gatewayArn(testAwsStoragegatewayGateway.arn())
            .build());

        var testCache = new Cache("testCache", CacheArgs.builder()
            .diskId(test.applyValue(getLocalDiskResult -> getLocalDiskResult.diskId()))
            .gatewayArn(testAwsStoragegatewayGateway.arn())
            .build());

    }
}
Copy
resources:
  testVolumeAttachment:
    type: aws:ec2:VolumeAttachment
    name: test
    properties:
      deviceName: /dev/xvdb
      volumeId: ${testAwsEbsVolume.id}
      instanceId: ${testAwsInstance.id}
  testCache:
    type: aws:storagegateway:Cache
    name: test
    properties:
      diskId: ${test.diskId}
      gatewayArn: ${testAwsStoragegatewayGateway.arn}
variables:
  test:
    fn::invoke:
      function: aws:storagegateway:getLocalDisk
      arguments:
        diskNode: ${testAwsVolumeAttachment.deviceName}
        gatewayArn: ${testAwsStoragegatewayGateway.arn}
Copy

FSx File Gateway

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "FILE_FSX_SMB",
    smbActiveDirectorySettings: {
        domainName: "corp.example.com",
        password: "avoid-plaintext-passwords",
        username: "Admin",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="FILE_FSX_SMB",
    smb_active_directory_settings={
        "domain_name": "corp.example.com",
        "password": "avoid-plaintext-passwords",
        "username": "Admin",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewGateway(ctx, "example", &storagegateway.GatewayArgs{
			GatewayIpAddress: pulumi.String("1.2.3.4"),
			GatewayName:      pulumi.String("example"),
			GatewayTimezone:  pulumi.String("GMT"),
			GatewayType:      pulumi.String("FILE_FSX_SMB"),
			SmbActiveDirectorySettings: &storagegateway.GatewaySmbActiveDirectorySettingsArgs{
				DomainName: pulumi.String("corp.example.com"),
				Password:   pulumi.String("avoid-plaintext-passwords"),
				Username:   pulumi.String("Admin"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.Gateway("example", new()
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "FILE_FSX_SMB",
        SmbActiveDirectorySettings = new Aws.StorageGateway.Inputs.GatewaySmbActiveDirectorySettingsArgs
        {
            DomainName = "corp.example.com",
            Password = "avoid-plaintext-passwords",
            Username = "Admin",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
import com.pulumi.aws.storagegateway.inputs.GatewaySmbActiveDirectorySettingsArgs;
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 Gateway("example", GatewayArgs.builder()
            .gatewayIpAddress("1.2.3.4")
            .gatewayName("example")
            .gatewayTimezone("GMT")
            .gatewayType("FILE_FSX_SMB")
            .smbActiveDirectorySettings(GatewaySmbActiveDirectorySettingsArgs.builder()
                .domainName("corp.example.com")
                .password("avoid-plaintext-passwords")
                .username("Admin")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: FILE_FSX_SMB
      smbActiveDirectorySettings:
        domainName: corp.example.com
        password: avoid-plaintext-passwords
        username: Admin
Copy

S3 File Gateway

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "FILE_S3",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="FILE_S3")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewGateway(ctx, "example", &storagegateway.GatewayArgs{
			GatewayIpAddress: pulumi.String("1.2.3.4"),
			GatewayName:      pulumi.String("example"),
			GatewayTimezone:  pulumi.String("GMT"),
			GatewayType:      pulumi.String("FILE_S3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.Gateway("example", new()
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "FILE_S3",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
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 Gateway("example", GatewayArgs.builder()
            .gatewayIpAddress("1.2.3.4")
            .gatewayName("example")
            .gatewayTimezone("GMT")
            .gatewayType("FILE_S3")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: FILE_S3
Copy

Tape Gateway

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "VTL",
    mediumChangerType: "AWS-Gateway-VTL",
    tapeDriveType: "IBM-ULT3580-TD5",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="VTL",
    medium_changer_type="AWS-Gateway-VTL",
    tape_drive_type="IBM-ULT3580-TD5")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewGateway(ctx, "example", &storagegateway.GatewayArgs{
			GatewayIpAddress:  pulumi.String("1.2.3.4"),
			GatewayName:       pulumi.String("example"),
			GatewayTimezone:   pulumi.String("GMT"),
			GatewayType:       pulumi.String("VTL"),
			MediumChangerType: pulumi.String("AWS-Gateway-VTL"),
			TapeDriveType:     pulumi.String("IBM-ULT3580-TD5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.Gateway("example", new()
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "VTL",
        MediumChangerType = "AWS-Gateway-VTL",
        TapeDriveType = "IBM-ULT3580-TD5",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
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 Gateway("example", GatewayArgs.builder()
            .gatewayIpAddress("1.2.3.4")
            .gatewayName("example")
            .gatewayTimezone("GMT")
            .gatewayType("VTL")
            .mediumChangerType("AWS-Gateway-VTL")
            .tapeDriveType("IBM-ULT3580-TD5")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: VTL
      mediumChangerType: AWS-Gateway-VTL
      tapeDriveType: IBM-ULT3580-TD5
Copy

Volume Gateway (Cached)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "CACHED",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="CACHED")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewGateway(ctx, "example", &storagegateway.GatewayArgs{
			GatewayIpAddress: pulumi.String("1.2.3.4"),
			GatewayName:      pulumi.String("example"),
			GatewayTimezone:  pulumi.String("GMT"),
			GatewayType:      pulumi.String("CACHED"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.Gateway("example", new()
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "CACHED",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
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 Gateway("example", GatewayArgs.builder()
            .gatewayIpAddress("1.2.3.4")
            .gatewayName("example")
            .gatewayTimezone("GMT")
            .gatewayType("CACHED")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: CACHED
Copy

Volume Gateway (Stored)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "STORED",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="STORED")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewGateway(ctx, "example", &storagegateway.GatewayArgs{
			GatewayIpAddress: pulumi.String("1.2.3.4"),
			GatewayName:      pulumi.String("example"),
			GatewayTimezone:  pulumi.String("GMT"),
			GatewayType:      pulumi.String("STORED"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.Gateway("example", new()
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "STORED",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
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 Gateway("example", GatewayArgs.builder()
            .gatewayIpAddress("1.2.3.4")
            .gatewayName("example")
            .gatewayTimezone("GMT")
            .gatewayType("STORED")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: STORED
Copy

Create Gateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            gateway_name: Optional[str] = None,
            gateway_timezone: Optional[str] = None,
            gateway_vpc_endpoint: Optional[str] = None,
            maintenance_start_time: Optional[GatewayMaintenanceStartTimeArgs] = None,
            gateway_ip_address: Optional[str] = None,
            average_upload_rate_limit_in_bits_per_sec: Optional[int] = None,
            average_download_rate_limit_in_bits_per_sec: Optional[int] = None,
            gateway_type: Optional[str] = None,
            activation_key: Optional[str] = None,
            cloudwatch_log_group_arn: Optional[str] = None,
            medium_changer_type: Optional[str] = None,
            smb_active_directory_settings: Optional[GatewaySmbActiveDirectorySettingsArgs] = None,
            smb_file_share_visibility: Optional[bool] = None,
            smb_guest_password: Optional[str] = None,
            smb_security_strategy: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tape_drive_type: Optional[str] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: aws:storagegateway:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var awsGatewayResource = new Aws.StorageGateway.Gateway("awsGatewayResource", new()
{
    GatewayName = "string",
    GatewayTimezone = "string",
    GatewayVpcEndpoint = "string",
    MaintenanceStartTime = new Aws.StorageGateway.Inputs.GatewayMaintenanceStartTimeArgs
    {
        HourOfDay = 0,
        DayOfMonth = "string",
        DayOfWeek = "string",
        MinuteOfHour = 0,
    },
    GatewayIpAddress = "string",
    AverageUploadRateLimitInBitsPerSec = 0,
    AverageDownloadRateLimitInBitsPerSec = 0,
    GatewayType = "string",
    ActivationKey = "string",
    CloudwatchLogGroupArn = "string",
    MediumChangerType = "string",
    SmbActiveDirectorySettings = new Aws.StorageGateway.Inputs.GatewaySmbActiveDirectorySettingsArgs
    {
        DomainName = "string",
        Password = "string",
        Username = "string",
        ActiveDirectoryStatus = "string",
        DomainControllers = new[]
        {
            "string",
        },
        OrganizationalUnit = "string",
        TimeoutInSeconds = 0,
    },
    SmbFileShareVisibility = false,
    SmbGuestPassword = "string",
    SmbSecurityStrategy = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TapeDriveType = "string",
});
Copy
example, err := storagegateway.NewGateway(ctx, "awsGatewayResource", &storagegateway.GatewayArgs{
	GatewayName:        pulumi.String("string"),
	GatewayTimezone:    pulumi.String("string"),
	GatewayVpcEndpoint: pulumi.String("string"),
	MaintenanceStartTime: &storagegateway.GatewayMaintenanceStartTimeArgs{
		HourOfDay:    pulumi.Int(0),
		DayOfMonth:   pulumi.String("string"),
		DayOfWeek:    pulumi.String("string"),
		MinuteOfHour: pulumi.Int(0),
	},
	GatewayIpAddress:                     pulumi.String("string"),
	AverageUploadRateLimitInBitsPerSec:   pulumi.Int(0),
	AverageDownloadRateLimitInBitsPerSec: pulumi.Int(0),
	GatewayType:                          pulumi.String("string"),
	ActivationKey:                        pulumi.String("string"),
	CloudwatchLogGroupArn:                pulumi.String("string"),
	MediumChangerType:                    pulumi.String("string"),
	SmbActiveDirectorySettings: &storagegateway.GatewaySmbActiveDirectorySettingsArgs{
		DomainName:            pulumi.String("string"),
		Password:              pulumi.String("string"),
		Username:              pulumi.String("string"),
		ActiveDirectoryStatus: pulumi.String("string"),
		DomainControllers: pulumi.StringArray{
			pulumi.String("string"),
		},
		OrganizationalUnit: pulumi.String("string"),
		TimeoutInSeconds:   pulumi.Int(0),
	},
	SmbFileShareVisibility: pulumi.Bool(false),
	SmbGuestPassword:       pulumi.String("string"),
	SmbSecurityStrategy:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TapeDriveType: pulumi.String("string"),
})
Copy
var awsGatewayResource = new Gateway("awsGatewayResource", GatewayArgs.builder()
    .gatewayName("string")
    .gatewayTimezone("string")
    .gatewayVpcEndpoint("string")
    .maintenanceStartTime(GatewayMaintenanceStartTimeArgs.builder()
        .hourOfDay(0)
        .dayOfMonth("string")
        .dayOfWeek("string")
        .minuteOfHour(0)
        .build())
    .gatewayIpAddress("string")
    .averageUploadRateLimitInBitsPerSec(0)
    .averageDownloadRateLimitInBitsPerSec(0)
    .gatewayType("string")
    .activationKey("string")
    .cloudwatchLogGroupArn("string")
    .mediumChangerType("string")
    .smbActiveDirectorySettings(GatewaySmbActiveDirectorySettingsArgs.builder()
        .domainName("string")
        .password("string")
        .username("string")
        .activeDirectoryStatus("string")
        .domainControllers("string")
        .organizationalUnit("string")
        .timeoutInSeconds(0)
        .build())
    .smbFileShareVisibility(false)
    .smbGuestPassword("string")
    .smbSecurityStrategy("string")
    .tags(Map.of("string", "string"))
    .tapeDriveType("string")
    .build());
Copy
aws_gateway_resource = aws.storagegateway.Gateway("awsGatewayResource",
    gateway_name="string",
    gateway_timezone="string",
    gateway_vpc_endpoint="string",
    maintenance_start_time={
        "hour_of_day": 0,
        "day_of_month": "string",
        "day_of_week": "string",
        "minute_of_hour": 0,
    },
    gateway_ip_address="string",
    average_upload_rate_limit_in_bits_per_sec=0,
    average_download_rate_limit_in_bits_per_sec=0,
    gateway_type="string",
    activation_key="string",
    cloudwatch_log_group_arn="string",
    medium_changer_type="string",
    smb_active_directory_settings={
        "domain_name": "string",
        "password": "string",
        "username": "string",
        "active_directory_status": "string",
        "domain_controllers": ["string"],
        "organizational_unit": "string",
        "timeout_in_seconds": 0,
    },
    smb_file_share_visibility=False,
    smb_guest_password="string",
    smb_security_strategy="string",
    tags={
        "string": "string",
    },
    tape_drive_type="string")
Copy
const awsGatewayResource = new aws.storagegateway.Gateway("awsGatewayResource", {
    gatewayName: "string",
    gatewayTimezone: "string",
    gatewayVpcEndpoint: "string",
    maintenanceStartTime: {
        hourOfDay: 0,
        dayOfMonth: "string",
        dayOfWeek: "string",
        minuteOfHour: 0,
    },
    gatewayIpAddress: "string",
    averageUploadRateLimitInBitsPerSec: 0,
    averageDownloadRateLimitInBitsPerSec: 0,
    gatewayType: "string",
    activationKey: "string",
    cloudwatchLogGroupArn: "string",
    mediumChangerType: "string",
    smbActiveDirectorySettings: {
        domainName: "string",
        password: "string",
        username: "string",
        activeDirectoryStatus: "string",
        domainControllers: ["string"],
        organizationalUnit: "string",
        timeoutInSeconds: 0,
    },
    smbFileShareVisibility: false,
    smbGuestPassword: "string",
    smbSecurityStrategy: "string",
    tags: {
        string: "string",
    },
    tapeDriveType: "string",
});
Copy
type: aws:storagegateway:Gateway
properties:
    activationKey: string
    averageDownloadRateLimitInBitsPerSec: 0
    averageUploadRateLimitInBitsPerSec: 0
    cloudwatchLogGroupArn: string
    gatewayIpAddress: string
    gatewayName: string
    gatewayTimezone: string
    gatewayType: string
    gatewayVpcEndpoint: string
    maintenanceStartTime:
        dayOfMonth: string
        dayOfWeek: string
        hourOfDay: 0
        minuteOfHour: 0
    mediumChangerType: string
    smbActiveDirectorySettings:
        activeDirectoryStatus: string
        domainControllers:
            - string
        domainName: string
        organizationalUnit: string
        password: string
        timeoutInSeconds: 0
        username: string
    smbFileShareVisibility: false
    smbGuestPassword: string
    smbSecurityStrategy: string
    tags:
        string: string
    tapeDriveType: string
Copy

Gateway Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Gateway resource accepts the following input properties:

GatewayName This property is required. string
Name of the gateway.
GatewayTimezone This property is required. string
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
ActivationKey Changes to this property will trigger replacement. string
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
AverageDownloadRateLimitInBitsPerSec int
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
AverageUploadRateLimitInBitsPerSec int
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
CloudwatchLogGroupArn string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
GatewayIpAddress Changes to this property will trigger replacement. string
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
GatewayType Changes to this property will trigger replacement. string
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
GatewayVpcEndpoint Changes to this property will trigger replacement. string
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
MaintenanceStartTime GatewayMaintenanceStartTime
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
MediumChangerType Changes to this property will trigger replacement. string
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
SmbActiveDirectorySettings GatewaySmbActiveDirectorySettings
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
SmbFileShareVisibility bool
Specifies whether the shares on this gateway appear when listing shares.
SmbGuestPassword string
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
SmbSecurityStrategy string
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
Tags Dictionary<string, string>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TapeDriveType Changes to this property will trigger replacement. string
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
GatewayName This property is required. string
Name of the gateway.
GatewayTimezone This property is required. string
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
ActivationKey Changes to this property will trigger replacement. string
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
AverageDownloadRateLimitInBitsPerSec int
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
AverageUploadRateLimitInBitsPerSec int
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
CloudwatchLogGroupArn string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
GatewayIpAddress Changes to this property will trigger replacement. string
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
GatewayType Changes to this property will trigger replacement. string
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
GatewayVpcEndpoint Changes to this property will trigger replacement. string
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
MaintenanceStartTime GatewayMaintenanceStartTimeArgs
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
MediumChangerType Changes to this property will trigger replacement. string
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
SmbActiveDirectorySettings GatewaySmbActiveDirectorySettingsArgs
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
SmbFileShareVisibility bool
Specifies whether the shares on this gateway appear when listing shares.
SmbGuestPassword string
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
SmbSecurityStrategy string
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
Tags map[string]string
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TapeDriveType Changes to this property will trigger replacement. string
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
gatewayName This property is required. String
Name of the gateway.
gatewayTimezone This property is required. String
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
activationKey Changes to this property will trigger replacement. String
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
averageDownloadRateLimitInBitsPerSec Integer
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
averageUploadRateLimitInBitsPerSec Integer
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatchLogGroupArn String
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
gatewayIpAddress Changes to this property will trigger replacement. String
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gatewayType Changes to this property will trigger replacement. String
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gatewayVpcEndpoint Changes to this property will trigger replacement. String
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
maintenanceStartTime GatewayMaintenanceStartTime
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
mediumChangerType Changes to this property will trigger replacement. String
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smbActiveDirectorySettings GatewaySmbActiveDirectorySettings
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smbFileShareVisibility Boolean
Specifies whether the shares on this gateway appear when listing shares.
smbGuestPassword String
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smbSecurityStrategy String
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags Map<String,String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tapeDriveType Changes to this property will trigger replacement. String
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
gatewayName This property is required. string
Name of the gateway.
gatewayTimezone This property is required. string
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
activationKey Changes to this property will trigger replacement. string
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
averageDownloadRateLimitInBitsPerSec number
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
averageUploadRateLimitInBitsPerSec number
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatchLogGroupArn string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
gatewayIpAddress Changes to this property will trigger replacement. string
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gatewayType Changes to this property will trigger replacement. string
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gatewayVpcEndpoint Changes to this property will trigger replacement. string
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
maintenanceStartTime GatewayMaintenanceStartTime
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
mediumChangerType Changes to this property will trigger replacement. string
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smbActiveDirectorySettings GatewaySmbActiveDirectorySettings
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smbFileShareVisibility boolean
Specifies whether the shares on this gateway appear when listing shares.
smbGuestPassword string
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smbSecurityStrategy string
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags {[key: string]: string}
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tapeDriveType Changes to this property will trigger replacement. string
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
gateway_name This property is required. str
Name of the gateway.
gateway_timezone This property is required. str
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
activation_key Changes to this property will trigger replacement. str
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
average_download_rate_limit_in_bits_per_sec int
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
average_upload_rate_limit_in_bits_per_sec int
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatch_log_group_arn str
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
gateway_ip_address Changes to this property will trigger replacement. str
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gateway_type Changes to this property will trigger replacement. str
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gateway_vpc_endpoint Changes to this property will trigger replacement. str
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
maintenance_start_time GatewayMaintenanceStartTimeArgs
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
medium_changer_type Changes to this property will trigger replacement. str
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smb_active_directory_settings GatewaySmbActiveDirectorySettingsArgs
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smb_file_share_visibility bool
Specifies whether the shares on this gateway appear when listing shares.
smb_guest_password str
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smb_security_strategy str
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags Mapping[str, str]
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tape_drive_type Changes to this property will trigger replacement. str
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
gatewayName This property is required. String
Name of the gateway.
gatewayTimezone This property is required. String
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
activationKey Changes to this property will trigger replacement. String
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
averageDownloadRateLimitInBitsPerSec Number
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
averageUploadRateLimitInBitsPerSec Number
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatchLogGroupArn String
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
gatewayIpAddress Changes to this property will trigger replacement. String
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gatewayType Changes to this property will trigger replacement. String
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gatewayVpcEndpoint Changes to this property will trigger replacement. String
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
maintenanceStartTime Property Map
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
mediumChangerType Changes to this property will trigger replacement. String
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smbActiveDirectorySettings Property Map
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smbFileShareVisibility Boolean
Specifies whether the shares on this gateway appear when listing shares.
smbGuestPassword String
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smbSecurityStrategy String
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags Map<String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tapeDriveType Changes to this property will trigger replacement. String
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

Outputs

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

Arn string
Amazon Resource Name (ARN) of the gateway.
Ec2InstanceId string
The ID of the Amazon EC2 instance that was used to launch the gateway.
EndpointType string
The type of endpoint for your gateway.
GatewayId string
Identifier of the gateway.
GatewayNetworkInterfaces List<GatewayGatewayNetworkInterface>
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
HostEnvironment string
The type of hypervisor environment used by the host.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the gateway.
Ec2InstanceId string
The ID of the Amazon EC2 instance that was used to launch the gateway.
EndpointType string
The type of endpoint for your gateway.
GatewayId string
Identifier of the gateway.
GatewayNetworkInterfaces []GatewayGatewayNetworkInterface
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
HostEnvironment string
The type of hypervisor environment used by the host.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the gateway.
ec2InstanceId String
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpointType String
The type of endpoint for your gateway.
gatewayId String
Identifier of the gateway.
gatewayNetworkInterfaces List<GatewayGatewayNetworkInterface>
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
hostEnvironment String
The type of hypervisor environment used by the host.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the gateway.
ec2InstanceId string
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpointType string
The type of endpoint for your gateway.
gatewayId string
Identifier of the gateway.
gatewayNetworkInterfaces GatewayGatewayNetworkInterface[]
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
hostEnvironment string
The type of hypervisor environment used by the host.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the gateway.
ec2_instance_id str
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpoint_type str
The type of endpoint for your gateway.
gateway_id str
Identifier of the gateway.
gateway_network_interfaces Sequence[GatewayGatewayNetworkInterface]
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
host_environment str
The type of hypervisor environment used by the host.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the gateway.
ec2InstanceId String
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpointType String
The type of endpoint for your gateway.
gatewayId String
Identifier of the gateway.
gatewayNetworkInterfaces List<Property Map>
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
hostEnvironment String
The type of hypervisor environment used by the host.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing Gateway Resource

Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_key: Optional[str] = None,
        arn: Optional[str] = None,
        average_download_rate_limit_in_bits_per_sec: Optional[int] = None,
        average_upload_rate_limit_in_bits_per_sec: Optional[int] = None,
        cloudwatch_log_group_arn: Optional[str] = None,
        ec2_instance_id: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        gateway_id: Optional[str] = None,
        gateway_ip_address: Optional[str] = None,
        gateway_name: Optional[str] = None,
        gateway_network_interfaces: Optional[Sequence[GatewayGatewayNetworkInterfaceArgs]] = None,
        gateway_timezone: Optional[str] = None,
        gateway_type: Optional[str] = None,
        gateway_vpc_endpoint: Optional[str] = None,
        host_environment: Optional[str] = None,
        maintenance_start_time: Optional[GatewayMaintenanceStartTimeArgs] = None,
        medium_changer_type: Optional[str] = None,
        smb_active_directory_settings: Optional[GatewaySmbActiveDirectorySettingsArgs] = None,
        smb_file_share_visibility: Optional[bool] = None,
        smb_guest_password: Optional[str] = None,
        smb_security_strategy: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        tape_drive_type: Optional[str] = None) -> Gateway
func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
resources:  _:    type: aws:storagegateway:Gateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActivationKey Changes to this property will trigger replacement. string
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
Arn string
Amazon Resource Name (ARN) of the gateway.
AverageDownloadRateLimitInBitsPerSec int
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
AverageUploadRateLimitInBitsPerSec int
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
CloudwatchLogGroupArn string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
Ec2InstanceId string
The ID of the Amazon EC2 instance that was used to launch the gateway.
EndpointType string
The type of endpoint for your gateway.
GatewayId string
Identifier of the gateway.
GatewayIpAddress Changes to this property will trigger replacement. string
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
GatewayName string
Name of the gateway.
GatewayNetworkInterfaces List<GatewayGatewayNetworkInterface>
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
GatewayTimezone string
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
GatewayType Changes to this property will trigger replacement. string
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
GatewayVpcEndpoint Changes to this property will trigger replacement. string
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
HostEnvironment string
The type of hypervisor environment used by the host.
MaintenanceStartTime GatewayMaintenanceStartTime
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
MediumChangerType Changes to this property will trigger replacement. string
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
SmbActiveDirectorySettings GatewaySmbActiveDirectorySettings
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
SmbFileShareVisibility bool
Specifies whether the shares on this gateway appear when listing shares.
SmbGuestPassword string
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
SmbSecurityStrategy string
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
Tags Dictionary<string, string>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TapeDriveType Changes to this property will trigger replacement. string
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
ActivationKey Changes to this property will trigger replacement. string
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
Arn string
Amazon Resource Name (ARN) of the gateway.
AverageDownloadRateLimitInBitsPerSec int
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
AverageUploadRateLimitInBitsPerSec int
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
CloudwatchLogGroupArn string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
Ec2InstanceId string
The ID of the Amazon EC2 instance that was used to launch the gateway.
EndpointType string
The type of endpoint for your gateway.
GatewayId string
Identifier of the gateway.
GatewayIpAddress Changes to this property will trigger replacement. string
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
GatewayName string
Name of the gateway.
GatewayNetworkInterfaces []GatewayGatewayNetworkInterfaceArgs
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
GatewayTimezone string
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
GatewayType Changes to this property will trigger replacement. string
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
GatewayVpcEndpoint Changes to this property will trigger replacement. string
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
HostEnvironment string
The type of hypervisor environment used by the host.
MaintenanceStartTime GatewayMaintenanceStartTimeArgs
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
MediumChangerType Changes to this property will trigger replacement. string
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
SmbActiveDirectorySettings GatewaySmbActiveDirectorySettingsArgs
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
SmbFileShareVisibility bool
Specifies whether the shares on this gateway appear when listing shares.
SmbGuestPassword string
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
SmbSecurityStrategy string
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
Tags map[string]string
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TapeDriveType Changes to this property will trigger replacement. string
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
activationKey Changes to this property will trigger replacement. String
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
arn String
Amazon Resource Name (ARN) of the gateway.
averageDownloadRateLimitInBitsPerSec Integer
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
averageUploadRateLimitInBitsPerSec Integer
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatchLogGroupArn String
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
ec2InstanceId String
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpointType String
The type of endpoint for your gateway.
gatewayId String
Identifier of the gateway.
gatewayIpAddress Changes to this property will trigger replacement. String
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gatewayName String
Name of the gateway.
gatewayNetworkInterfaces List<GatewayGatewayNetworkInterface>
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
gatewayTimezone String
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
gatewayType Changes to this property will trigger replacement. String
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gatewayVpcEndpoint Changes to this property will trigger replacement. String
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
hostEnvironment String
The type of hypervisor environment used by the host.
maintenanceStartTime GatewayMaintenanceStartTime
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
mediumChangerType Changes to this property will trigger replacement. String
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smbActiveDirectorySettings GatewaySmbActiveDirectorySettings
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smbFileShareVisibility Boolean
Specifies whether the shares on this gateway appear when listing shares.
smbGuestPassword String
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smbSecurityStrategy String
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags Map<String,String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tapeDriveType Changes to this property will trigger replacement. String
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
activationKey Changes to this property will trigger replacement. string
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
arn string
Amazon Resource Name (ARN) of the gateway.
averageDownloadRateLimitInBitsPerSec number
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
averageUploadRateLimitInBitsPerSec number
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatchLogGroupArn string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
ec2InstanceId string
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpointType string
The type of endpoint for your gateway.
gatewayId string
Identifier of the gateway.
gatewayIpAddress Changes to this property will trigger replacement. string
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gatewayName string
Name of the gateway.
gatewayNetworkInterfaces GatewayGatewayNetworkInterface[]
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
gatewayTimezone string
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
gatewayType Changes to this property will trigger replacement. string
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gatewayVpcEndpoint Changes to this property will trigger replacement. string
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
hostEnvironment string
The type of hypervisor environment used by the host.
maintenanceStartTime GatewayMaintenanceStartTime
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
mediumChangerType Changes to this property will trigger replacement. string
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smbActiveDirectorySettings GatewaySmbActiveDirectorySettings
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smbFileShareVisibility boolean
Specifies whether the shares on this gateway appear when listing shares.
smbGuestPassword string
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smbSecurityStrategy string
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags {[key: string]: string}
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tapeDriveType Changes to this property will trigger replacement. string
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
activation_key Changes to this property will trigger replacement. str
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
arn str
Amazon Resource Name (ARN) of the gateway.
average_download_rate_limit_in_bits_per_sec int
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
average_upload_rate_limit_in_bits_per_sec int
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatch_log_group_arn str
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
ec2_instance_id str
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpoint_type str
The type of endpoint for your gateway.
gateway_id str
Identifier of the gateway.
gateway_ip_address Changes to this property will trigger replacement. str
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gateway_name str
Name of the gateway.
gateway_network_interfaces Sequence[GatewayGatewayNetworkInterfaceArgs]
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
gateway_timezone str
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
gateway_type Changes to this property will trigger replacement. str
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gateway_vpc_endpoint Changes to this property will trigger replacement. str
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
host_environment str
The type of hypervisor environment used by the host.
maintenance_start_time GatewayMaintenanceStartTimeArgs
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
medium_changer_type Changes to this property will trigger replacement. str
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smb_active_directory_settings GatewaySmbActiveDirectorySettingsArgs
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smb_file_share_visibility bool
Specifies whether the shares on this gateway appear when listing shares.
smb_guest_password str
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smb_security_strategy str
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags Mapping[str, str]
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tape_drive_type Changes to this property will trigger replacement. str
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
activationKey Changes to this property will trigger replacement. String
Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
arn String
Amazon Resource Name (ARN) of the gateway.
averageDownloadRateLimitInBitsPerSec Number
The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
averageUploadRateLimitInBitsPerSec Number
The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.
cloudwatchLogGroupArn String
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
ec2InstanceId String
The ID of the Amazon EC2 instance that was used to launch the gateway.
endpointType String
The type of endpoint for your gateway.
gatewayId String
Identifier of the gateway.
gatewayIpAddress Changes to this property will trigger replacement. String
Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.
gatewayName String
Name of the gateway.
gatewayNetworkInterfaces List<Property Map>
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
gatewayTimezone String
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
gatewayType Changes to this property will trigger replacement. String
Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.
gatewayVpcEndpoint Changes to this property will trigger replacement. String
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running this provider. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.
hostEnvironment String
The type of hypervisor environment used by the host.
maintenanceStartTime Property Map
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
mediumChangerType Changes to this property will trigger replacement. String
Type of medium changer to use for tape gateway. This provider cannot detect drift of this argument. Valid values: STK-L700, AWS-Gateway-VTL, IBM-03584L32-0402.
smbActiveDirectorySettings Property Map
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.
smbFileShareVisibility Boolean
Specifies whether the shares on this gateway appear when listing shares.
smbGuestPassword String
Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 and FILE_FSX_SMB gateway types. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.
smbSecurityStrategy String
Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.
tags Map<String>
Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tapeDriveType Changes to this property will trigger replacement. String
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

Supporting Types

GatewayGatewayNetworkInterface
, GatewayGatewayNetworkInterfaceArgs

Ipv4Address string
The Internet Protocol version 4 (IPv4) address of the interface.
Ipv4Address string
The Internet Protocol version 4 (IPv4) address of the interface.
ipv4Address String
The Internet Protocol version 4 (IPv4) address of the interface.
ipv4Address string
The Internet Protocol version 4 (IPv4) address of the interface.
ipv4_address str
The Internet Protocol version 4 (IPv4) address of the interface.
ipv4Address String
The Internet Protocol version 4 (IPv4) address of the interface.

GatewayMaintenanceStartTime
, GatewayMaintenanceStartTimeArgs

HourOfDay This property is required. int
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
DayOfMonth string
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
DayOfWeek string
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
MinuteOfHour int
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
HourOfDay This property is required. int
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
DayOfMonth string
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
DayOfWeek string
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
MinuteOfHour int
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
hourOfDay This property is required. Integer
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
dayOfMonth String
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
dayOfWeek String
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
minuteOfHour Integer
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
hourOfDay This property is required. number
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
dayOfMonth string
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
dayOfWeek string
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
minuteOfHour number
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
hour_of_day This property is required. int
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
day_of_month str
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
day_of_week str
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
minute_of_hour int
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
hourOfDay This property is required. Number
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
dayOfMonth String
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
dayOfWeek String
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
minuteOfHour Number
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.

GatewaySmbActiveDirectorySettings
, GatewaySmbActiveDirectorySettingsArgs

DomainName This property is required. string
The name of the domain that you want the gateway to join.
Password This property is required. string
The password of the user who has permission to add the gateway to the Active Directory domain.
Username This property is required. string
The user name of user who has permission to add the gateway to the Active Directory domain.
ActiveDirectoryStatus string
DomainControllers List<string>
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
OrganizationalUnit string
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
TimeoutInSeconds int
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
DomainName This property is required. string
The name of the domain that you want the gateway to join.
Password This property is required. string
The password of the user who has permission to add the gateway to the Active Directory domain.
Username This property is required. string
The user name of user who has permission to add the gateway to the Active Directory domain.
ActiveDirectoryStatus string
DomainControllers []string
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
OrganizationalUnit string
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
TimeoutInSeconds int
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
domainName This property is required. String
The name of the domain that you want the gateway to join.
password This property is required. String
The password of the user who has permission to add the gateway to the Active Directory domain.
username This property is required. String
The user name of user who has permission to add the gateway to the Active Directory domain.
activeDirectoryStatus String
domainControllers List<String>
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
organizationalUnit String
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
timeoutInSeconds Integer
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
domainName This property is required. string
The name of the domain that you want the gateway to join.
password This property is required. string
The password of the user who has permission to add the gateway to the Active Directory domain.
username This property is required. string
The user name of user who has permission to add the gateway to the Active Directory domain.
activeDirectoryStatus string
domainControllers string[]
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
organizationalUnit string
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
timeoutInSeconds number
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
domain_name This property is required. str
The name of the domain that you want the gateway to join.
password This property is required. str
The password of the user who has permission to add the gateway to the Active Directory domain.
username This property is required. str
The user name of user who has permission to add the gateway to the Active Directory domain.
active_directory_status str
domain_controllers Sequence[str]
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
organizational_unit str
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
timeout_in_seconds int
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
domainName This property is required. String
The name of the domain that you want the gateway to join.
password This property is required. String
The password of the user who has permission to add the gateway to the Active Directory domain.
username This property is required. String
The user name of user who has permission to add the gateway to the Active Directory domain.
activeDirectoryStatus String
domainControllers List<String>
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
organizationalUnit String
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
timeoutInSeconds Number
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

Import

Using pulumi import, import aws_storagegateway_gateway using the gateway Amazon Resource Name (ARN). For example:

$ pulumi import aws:storagegateway/gateway:Gateway example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678
Copy

Certain resource arguments, like gateway_ip_address do not have a Storage Gateway API method for reading the information after creation, either omit the argument from the Pulumi program or use ignore_changes to hide the difference. For example:

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.