Gateway class
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.getLocalDiskOutput({
diskNode: testVolumeAttachment.deviceName,
gatewayArn: testAwsStoragegatewayGateway.arn,
});
const testCache = new aws.storagegateway.Cache("test", {
diskId: test.diskId,
gatewayArn: testAwsStoragegatewayGateway.arn,
});
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_output(disk_node=test_volume_attachment.device_name,
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"])
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 = testVolumeAttachment.DeviceName,
GatewayArn = testAwsStoragegatewayGateway.Arn,
});
var testCache = new Aws.StorageGateway.Cache("test", new()
{
DiskId = test.Apply(getLocalDiskResult => getLocalDiskResult.DiskId),
GatewayArn = testAwsStoragegatewayGateway.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/storagegateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
testVolumeAttachment, 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 := storagegateway.GetLocalDiskOutput(ctx, storagegateway.GetLocalDiskOutputArgs{
DiskNode: testVolumeAttachment.DeviceName,
GatewayArn: pulumi.Any(testAwsStoragegatewayGateway.Arn),
}, nil)
_, err = storagegateway.NewCache(ctx, "test", &storagegateway.CacheArgs{
DiskId: test.DiskId(),
GatewayArn: pulumi.Any(testAwsStoragegatewayGateway.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_storagegateway_getlocaldisk" "test" {
disk_node = aws_ec2_volumeattachment.test.device_name
gateway_arn = testAwsStoragegatewayGateway.arn
}
resource "aws_ec2_volumeattachment" "test" {
device_name = "/dev/xvdb"
volume_id = testAwsEbsVolume.id
instance_id = testAwsInstance.id
}
resource "aws_storagegateway_cache" "test" {
disk_id = data.aws_storagegateway_getlocaldisk.test.disk_id
gateway_arn = testAwsStoragegatewayGateway.arn
}
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testVolumeAttachment = new VolumeAttachment("testVolumeAttachment", VolumeAttachmentArgs.builder()
.deviceName("/dev/xvdb")
.volumeId(testAwsEbsVolume.id())
.instanceId(testAwsInstance.id())
.build());
final var test = StoragegatewayFunctions.getLocalDisk(GetLocalDiskArgs.builder()
.diskNode(testVolumeAttachment.deviceName())
.gatewayArn(testAwsStoragegatewayGateway.arn())
.build());
var testCache = new Cache("testCache", CacheArgs.builder()
.diskId(test.applyValue(_test -> _test.diskId()))
.gatewayArn(testAwsStoragegatewayGateway.arn())
.build());
}
}
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: ${testVolumeAttachment.deviceName}
gatewayArn: ${testAwsStoragegatewayGateway.arn}
FSx File Gateway
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.storagegateway.Gateway("example", {
smbActiveDirectorySettings: {
domainName: "corp.example.com",
password: "avoid-plaintext-passwords",
username: "Admin",
},
gatewayIpAddress: "1.2.3.4",
gatewayName: "example",
gatewayTimezone: "GMT",
gatewayType: "FILE_FSX_SMB",
});
import pulumi
import pulumi_aws as aws
example = aws.storagegateway.Gateway("example",
smb_active_directory_settings={
"domain_name": "corp.example.com",
"password": "avoid-plaintext-passwords",
"username": "Admin",
},
gateway_ip_address="1.2.3.4",
gateway_name="example",
gateway_timezone="GMT",
gateway_type="FILE_FSX_SMB")
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()
{
SmbActiveDirectorySettings = new Aws.StorageGateway.Inputs.GatewaySmbActiveDirectorySettingsArgs
{
DomainName = "corp.example.com",
Password = "avoid-plaintext-passwords",
Username = "Admin",
},
GatewayIpAddress = "1.2.3.4",
GatewayName = "example",
GatewayTimezone = "GMT",
GatewayType = "FILE_FSX_SMB",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
SmbActiveDirectorySettings: &storagegateway.GatewaySmbActiveDirectorySettingsArgs{
DomainName: pulumi.String("corp.example.com"),
Password: pulumi.String("avoid-plaintext-passwords"),
Username: pulumi.String("Admin"),
},
GatewayIpAddress: pulumi.String("1.2.3.4"),
GatewayName: pulumi.String("example"),
GatewayTimezone: pulumi.String("GMT"),
GatewayType: pulumi.String("FILE_FSX_SMB"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_storagegateway_gateway" "example" {
smb_active_directory_settings = {
domain_name = "corp.example.com"
password = "avoid-plaintext-passwords"
username = "Admin"
}
gateway_ip_address = "1.2.3.4"
gateway_name = "example"
gateway_timezone = "GMT"
gateway_type = "FILE_FSX_SMB"
}
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Gateway("example", GatewayArgs.builder()
.smbActiveDirectorySettings(GatewaySmbActiveDirectorySettingsArgs.builder()
.domainName("corp.example.com")
.password("avoid-plaintext-passwords")
.username("Admin")
.build())
.gatewayIpAddress("1.2.3.4")
.gatewayName("example")
.gatewayTimezone("GMT")
.gatewayType("FILE_FSX_SMB")
.build());
}
}
resources:
example:
type: aws:storagegateway:Gateway
properties:
smbActiveDirectorySettings:
domainName: corp.example.com
password: avoid-plaintext-passwords
username: Admin
gatewayIpAddress: 1.2.3.4
gatewayName: example
gatewayTimezone: GMT
gatewayType: FILE_FSX_SMB
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",
});
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")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_storagegateway_gateway" "example" {
gateway_ip_address = "1.2.3.4"
gateway_name = "example"
gateway_timezone = "GMT"
gateway_type = "FILE_S3"
}
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Gateway("example", GatewayArgs.builder()
.gatewayIpAddress("1.2.3.4")
.gatewayName("example")
.gatewayTimezone("GMT")
.gatewayType("FILE_S3")
.build());
}
}
resources:
example:
type: aws:storagegateway:Gateway
properties:
gatewayIpAddress: 1.2.3.4
gatewayName: example
gatewayTimezone: GMT
gatewayType: FILE_S3
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",
});
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")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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"
}
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Gateway("example", GatewayArgs.builder()
.gatewayIpAddress("1.2.3.4")
.gatewayName("example")
.gatewayTimezone("GMT")
.gatewayType("VTL")
.mediumChangerType("AWS-Gateway-VTL")
.tapeDriveType("IBM-ULT3580-TD5")
.build());
}
}
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
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",
});
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")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_storagegateway_gateway" "example" {
gateway_ip_address = "1.2.3.4"
gateway_name = "example"
gateway_timezone = "GMT"
gateway_type = "CACHED"
}
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Gateway("example", GatewayArgs.builder()
.gatewayIpAddress("1.2.3.4")
.gatewayName("example")
.gatewayTimezone("GMT")
.gatewayType("CACHED")
.build());
}
}
resources:
example:
type: aws:storagegateway:Gateway
properties:
gatewayIpAddress: 1.2.3.4
gatewayName: example
gatewayTimezone: GMT
gatewayType: CACHED
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",
});
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")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_storagegateway_gateway" "example" {
gateway_ip_address = "1.2.3.4"
gateway_name = "example"
gateway_timezone = "GMT"
gateway_type = "STORED"
}
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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Gateway("example", GatewayArgs.builder()
.gatewayIpAddress("1.2.3.4")
.gatewayName("example")
.gatewayTimezone("GMT")
.gatewayType("STORED")
.build());
}
}
resources:
example:
type: aws:storagegateway:Gateway
properties:
gatewayIpAddress: 1.2.3.4
gatewayName: example
gatewayTimezone: GMT
gatewayType: STORED
Import
Using pulumi import, import aws.storagegateway.Gateway using the gateway ARN. For example:
$ pulumi import aws:storagegateway/gateway:Gateway example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678
Certain resource arguments, like gatewayIpAddress do not have a Storage Gateway API method for reading the information after creation, either omit the argument from the Pulumi program or use ignoreChanges to hide the difference. For example:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.storagegateway.Gateway("example", {gatewayIpAddress: sgw.privateIp}, {
ignoreChanges: ["gatewayIpAddress"],
});
import pulumi
import pulumi_aws as aws
example = aws.storagegateway.Gateway("example", gateway_ip_address=sgw["privateIp"],
opts = pulumi.ResourceOptions(ignore_changes=["gatewayIpAddress"]))
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 = sgw.PrivateIp,
}, new CustomResourceOptions
{
IgnoreChanges =
{
"gatewayIpAddress",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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.Any(sgw.PrivateIp),
}, pulumi.IgnoreChanges([]string{
"gatewayIpAddress",
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_storagegateway_gateway" "example" {
lifecycle {
ignore_changes = [gatewayIpAddress]
}
gateway_ip_address = sgw.privateIp
}
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.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Gateway("example", GatewayArgs.builder()
.gatewayIpAddress(sgw.privateIp())
.build(), CustomResourceOptions.builder()
.ignoreChanges("gatewayIpAddress")
.build());
}
}
resources:
example:
type: aws:storagegateway:Gateway
properties:
gatewayIpAddress: ${sgw.privateIp}
options:
ignoreChanges:
- gatewayIpAddress
Constructors
- Gateway(String name, {GatewayArgs? args, CustomResourceOptions? options})
-
Creates a new Gateway.
nameThe Pulumi resource name.argsArguments used to configure this Gateway. The set of arguments for Gateway.optionsResource options controlling this resource's behavior. - Gateway.reference(String urn)
- Creates a typed reference to an existing Gateway resource.
Properties
-
activationKey
↔ Output<
String> -
Gateway activation key during resource creation. Conflicts with
gatewayIpAddress. Additional information is available in the Storage Gateway User Guide.latefinal -
arn
↔ Output<
String> -
ARN of the gateway.
latefinal
-
averageDownloadRateLimitInBitsPerSec
↔ Output<
int?> -
The average download bandwidth rate limit in bits per second. This is supported for the
CACHED,STORED, andVTLgateway types.latefinal -
averageUploadRateLimitInBitsPerSec
↔ Output<
int?> -
The average upload bandwidth rate limit in bits per second. This is supported for the
CACHED,STORED, andVTLgateway types.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
cloudwatchLogGroupArn
↔ Output<
String?> -
ARN of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
ec2InstanceId
↔ Output<
String> -
The ID of the Amazon EC2 instance that was used to launch the gateway.
latefinal
-
endpointType
↔ Output<
String> -
The type of endpoint for your gateway.
latefinal
-
gatewayId
↔ Output<
String> -
Identifier of the gateway.
latefinal
-
gatewayIpAddress
↔ Output<
String> -
Gateway IP address to retrieve activation key during resource creation. Conflicts with
activationKey. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.latefinal -
gatewayName
↔ Output<
String> -
Name of the gateway.
latefinal
-
gatewayNetworkInterfaces
↔ Output<
List< GatewayGatewayNetworkInterface> > -
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
latefinal
-
gatewayTimezone
↔ Output<
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:00indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.latefinal -
gatewayType
↔ Output<
String?> -
Type of the gateway. The default value is
STORED. Valid values:CACHED,FILE_FSX_SMB,FILE_S3,STORED,VTL.latefinal -
gatewayVpcEndpoint
↔ Output<
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 Pulumi. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a VPC.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hostEnvironment
↔ Output<
String> -
The type of hypervisor environment used by the host.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
maintenanceStartTime
↔ Output<
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.
latefinal
-
mediumChangerType
↔ Output<
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.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
smbActiveDirectorySettings
↔ Output<
GatewaySmbActiveDirectorySettings?> -
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for
FILE_S3andFILE_FSX_SMBgateway types. Must be set before creatingActiveDirectoryauthentication SMB file shares. More details below.latefinal -
Specifies whether the shares on this gateway appear when listing shares.
latefinal
-
smbGuestPassword
↔ Output<
String?> -
Guest password for Server Message Block (SMB) file shares. Only valid for
FILE_S3andFILE_FSX_SMBgateway types. Must be set before creatingGuestAccessauthentication 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.latefinal -
smbSecurityStrategy
↔ Output<
String> -
Specifies the type of security strategy. Valid values are:
ClientSpecified,MandatorySigning, andMandatoryEncryption. See Setting a Security Level for Your Gateway for more information.latefinal -
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
tapeDriveType
↔ Output<
String?> -
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values:
IBM-ULT3580-TD5.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited