Class 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

File Gateway

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.Gateway("example", new Aws.StorageGateway.GatewayArgs
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "FILE_S3",
    });
}

}

Volume Gateway (Cached)

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.Gateway("example", new Aws.StorageGateway.GatewayArgs
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "CACHED",
    });
}

}

Volume Gateway (Stored)

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.Gateway("example", new Aws.StorageGateway.GatewayArgs
    {
        GatewayIpAddress = "1.2.3.4",
        GatewayName = "example",
        GatewayTimezone = "GMT",
        GatewayType = "STORED",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Gateway

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.StorageGateway

Assembly: Pulumi.Aws.dll

Syntax

public class Gateway : CustomResource

Constructors

Gateway(String, GatewayArgs, CustomResourceOptions)

Create a Gateway resource with the given unique name, arguments, and options.

Declaration

public Gateway(string name, GatewayArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GatewayArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ActivationKey

Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.

Declaration

public Output<string> ActivationKey { get; }

Property Value

Type	Description
Output<System.String>

Arn

Amazon Resource Name (ARN) of the gateway.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

CloudwatchLogGroupArn

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.

Declaration

public Output<string> CloudwatchLogGroupArn { get; }

Property Value

Type	Description
Output<System.String>

GatewayId

Identifier of the gateway.

Declaration

public Output<string> GatewayId { get; }

Property Value

Type	Description
Output<System.String>

GatewayIpAddress

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.

Declaration

public Output<string> GatewayIpAddress { get; }

Property Value

Type	Description
Output<System.String>

GatewayName

Name of the gateway.

Declaration

public Output<string> GatewayName { get; }

Property Value

Type	Description
Output<System.String>

GatewayTimezone

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.

Declaration

public Output<string> GatewayTimezone { get; }

Property Value

Type	Description
Output<System.String>

GatewayType

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

Declaration

public Output<string> GatewayType { get; }

Property Value

Type	Description
Output<System.String>

GatewayVpcEndpoint

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 Virtual Private Cloud.

Declaration

public Output<string> GatewayVpcEndpoint { get; }

Property Value

Type	Description
Output<System.String>

MediumChangerType

Declaration

public Output<string> MediumChangerType { get; }

Property Value

Type	Description
Output<System.String>

SmbActiveDirectorySettings

Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 gateway type. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.

Declaration

public Output<GatewaySmbActiveDirectorySettings> SmbActiveDirectorySettings { get; }

Property Value

Type	Description
Output<GatewaySmbActiveDirectorySettings>

SmbGuestPassword

Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 gateway type. 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.

Declaration

public Output<string> SmbGuestPassword { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value mapping of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

TapeDriveType

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

Declaration

public Output<string> TapeDriveType { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, GatewayState, CustomResourceOptions)

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

Declaration

public static Gateway Get(string name, Input<string> id, GatewayState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GatewayState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Gateway