Gateway

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

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

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

    var testLocalDisk = Aws.StorageGateway.GetLocalDisk.Invoke(new()
    {
        DiskNode = testVolumeAttachment.DeviceName,
        GatewayArn = aws_storagegateway_gateway.Test.Arn,
    });

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

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v5/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, "testVolumeAttachment", &ec2.VolumeAttachmentArgs{
			DeviceName: pulumi.String("/dev/xvdb"),
			VolumeId:   pulumi.Any(aws_ebs_volume.Test.Id),
			InstanceId: pulumi.Any(aws_instance.Test.Id),
		})
		if err != nil {
			return err
		}
		testLocalDisk := testVolumeAttachment.DeviceName.ApplyT(func(deviceName string) (storagegateway.GetLocalDiskResult, error) {
			return storagegateway.GetLocalDiskOutput(ctx, storagegateway.GetLocalDiskOutputArgs{
				DiskNode:   deviceName,
				GatewayArn: aws_storagegateway_gateway.Test.Arn,
			}, nil), nil
		}).(storagegateway.GetLocalDiskResultOutput)
		_, err = storagegateway.NewCache(ctx, "testCache", &storagegateway.CacheArgs{
			DiskId: testLocalDisk.ApplyT(func(testLocalDisk storagegateway.GetLocalDiskResult) (string, error) {
				return testLocalDisk.DiskId, nil
			}).(pulumi.StringOutput),
			GatewayArn: pulumi.Any(aws_storagegateway_gateway.Test.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.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(aws_ebs_volume.test().id())
            .instanceId(aws_instance.test().id())
            .build());

        final var testLocalDisk = StoragegatewayFunctions.getLocalDisk(GetLocalDiskArgs.builder()
            .diskNode(testVolumeAttachment.deviceName())
            .gatewayArn(aws_storagegateway_gateway.test().arn())
            .build());

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

    }
}
import pulumi
import pulumi_aws as aws

test_volume_attachment = aws.ec2.VolumeAttachment("testVolumeAttachment",
    device_name="/dev/xvdb",
    volume_id=aws_ebs_volume["test"]["id"],
    instance_id=aws_instance["test"]["id"])
test_local_disk = test_volume_attachment.device_name.apply(lambda device_name: aws.storagegateway.get_local_disk_output(disk_node=device_name,
    gateway_arn=aws_storagegateway_gateway["test"]["arn"]))
test_cache = aws.storagegateway.Cache("testCache",
    disk_id=test_local_disk.disk_id,
    gateway_arn=aws_storagegateway_gateway["test"]["arn"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testVolumeAttachment = new aws.ec2.VolumeAttachment("testVolumeAttachment", {
    deviceName: "/dev/xvdb",
    volumeId: aws_ebs_volume.test.id,
    instanceId: aws_instance.test.id,
});
const testLocalDisk = testVolumeAttachment.deviceName.apply(deviceName => aws.storagegateway.getLocalDiskOutput({
    diskNode: deviceName,
    gatewayArn: aws_storagegateway_gateway.test.arn,
}));
const testCache = new aws.storagegateway.Cache("testCache", {
    diskId: testLocalDisk.apply(testLocalDisk => testLocalDisk.diskId),
    gatewayArn: aws_storagegateway_gateway.test.arn,
});
resources:
  testVolumeAttachment:
    type: aws:ec2:VolumeAttachment
    properties:
      deviceName: /dev/xvdb
      volumeId: ${aws_ebs_volume.test.id}
      instanceId: ${aws_instance.test.id}
  testCache:
    type: aws:storagegateway:Cache
    properties:
      diskId: ${testLocalDisk.diskId}
      gatewayArn: ${aws_storagegateway_gateway.test.arn}
variables:
  testLocalDisk:
    fn::invoke:
      Function: aws:storagegateway:getLocalDisk
      Arguments:
        diskNode: ${testVolumeAttachment.deviceName}
        gatewayArn: ${aws_storagegateway_gateway.test.arn}

FSx File Gateway

using System.Collections.Generic;
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",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}
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());

    }
}
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=aws.storagegateway.GatewaySmbActiveDirectorySettingsArgs(
        domain_name="corp.example.com",
        password="avoid-plaintext-passwords",
        username="Admin",
    ))
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",
    },
});
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

S3 File Gateway

using System.Collections.Generic;
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/v5/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
	})
}
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());

    }
}
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")
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",
});
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: FILE_S3

Tape Gateway

using System.Collections.Generic;
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/v5/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
	})
}
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());

    }
}
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")
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",
});
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)

using System.Collections.Generic;
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/v5/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
	})
}
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());

    }
}
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")
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",
});
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: CACHED

Volume Gateway (Stored)

using System.Collections.Generic;
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/v5/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
	})
}
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());

    }
}
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")
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",
});
resources:
  example:
    type: aws:storagegateway:Gateway
    properties:
      gatewayIpAddress: 1.2.3.4
      gatewayName: example
      gatewayTimezone: GMT
      gatewayType: STORED

Create Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            activation_key: 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,
            gateway_ip_address: Optional[str] = None,
            gateway_name: Optional[str] = None,
            gateway_timezone: Optional[str] = None,
            gateway_type: Optional[str] = None,
            gateway_vpc_endpoint: 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,
            tape_drive_type: Optional[str] = None)
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The Gateway resource accepts the following input properties:

GatewayName string

Name of the gateway.

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.

ActivationKey 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 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 string

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

GatewayVpcEndpoint 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 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 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 string

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

GatewayName string

Name of the gateway.

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.

ActivationKey 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 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 string

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

GatewayVpcEndpoint 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 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 string

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

gatewayName String

Name of the gateway.

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.

activationKey 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 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 String

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gatewayVpcEndpoint 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 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 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 String

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

gatewayName string

Name of the gateway.

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.

activationKey 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 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 string

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gatewayVpcEndpoint 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 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 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 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 str

Name of the gateway.

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.

activation_key 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 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 str

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gateway_vpc_endpoint 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 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 str

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

gatewayName String

Name of the gateway.

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.

activationKey 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 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 String

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gatewayVpcEndpoint 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 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 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.

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.

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.

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.

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.

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.

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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActivationKey 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 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<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 string

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

GatewayVpcEndpoint 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 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 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.

TapeDriveType string

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

ActivationKey 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 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 string

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

GatewayVpcEndpoint 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 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.

TapeDriveType string

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

activationKey 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 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<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 String

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gatewayVpcEndpoint 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 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 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.

tapeDriveType String

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

activationKey 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 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 string

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gatewayVpcEndpoint 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 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 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.

tapeDriveType 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 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 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 str

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gateway_vpc_endpoint 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 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.

tape_drive_type str

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

activationKey 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 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 String

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_FSX_SMB, FILE_S3, STORED, VTL.

gatewayVpcEndpoint 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 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.

tapeDriveType 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

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

HourOfDay 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 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 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 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 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 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

DomainName string

The name of the domain that you want the gateway to join.

Password string

The password of the user who has permission to add the gateway to the Active Directory domain.

Username 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 string

The name of the domain that you want the gateway to join.

Password string

The password of the user who has permission to add the gateway to the Active Directory domain.

Username 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 String

The name of the domain that you want the gateway to join.

password String

The password of the user who has permission to add the gateway to the Active Directory domain.

username 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 string

The name of the domain that you want the gateway to join.

password string

The password of the user who has permission to add the gateway to the Active Directory domain.

username 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 str

The name of the domain that you want the gateway to join.

password str

The password of the user who has permission to add the gateway to the Active Directory domain.

username 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 String

The name of the domain that you want the gateway to join.

password String

The password of the user who has permission to add the gateway to the Active Directory domain.

username 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

aws_storagegateway_gateway can be imported by using the gateway Amazon Resource Name (ARN), e.g.,

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

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 provider configuration or use ignoreChanges to hide the difference. terraform resource “aws_storagegateway_gateway” “example” {

… other configuration …

gateway_ip_address = aws_instance.sgw.private_ip

There is no Storage Gateway API for reading gateway_ip_address

lifecycle {

ignore_changes = [“gateway_ip_address”]

} }

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.