pulumi-aws-kotlin/com.pulumi.aws.storagegateway.kotlin/GatewayArgs

GatewayArgs

data class GatewayArgs(val activationKey: Output<String>? = null, val averageDownloadRateLimitInBitsPerSec: Output<Int>? = null, val averageUploadRateLimitInBitsPerSec: Output<Int>? = null, val cloudwatchLogGroupArn: Output<String>? = null, val gatewayIpAddress: Output<String>? = null, val gatewayName: Output<String>? = null, val gatewayTimezone: Output<String>? = null, val gatewayType: Output<String>? = null, val gatewayVpcEndpoint: Output<String>? = null, val maintenanceStartTime: Output<GatewayMaintenanceStartTimeArgs>? = null, val mediumChangerType: Output<String>? = null, val smbActiveDirectorySettings: Output<GatewaySmbActiveDirectorySettingsArgs>? = null, val smbFileShareVisibility: Output<Boolean>? = null, val smbGuestPassword: Output<String>? = null, val smbSecurityStrategy: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val tapeDriveType: Output<String>? = null) : ConvertibleToJava<GatewayArgs>

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

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());
    }
}
Content copied to clipboard

FSx File Gateway

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());
    }
}
Content copied to clipboard

S3 File Gateway

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());
    }
}
Content copied to clipboard

Tape Gateway

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());
    }
}
Content copied to clipboard

Volume Gateway (Cached)

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
import java.util.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());
    }
}
Content copied to clipboard

Volume Gateway (Stored)

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
import java.util.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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

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" } }

Constructors

Link copied to clipboard
constructor(activationKey: Output<String>? = null, averageDownloadRateLimitInBitsPerSec: Output<Int>? = null, averageUploadRateLimitInBitsPerSec: Output<Int>? = null, cloudwatchLogGroupArn: Output<String>? = null, gatewayIpAddress: Output<String>? = null, gatewayName: Output<String>? = null, gatewayTimezone: Output<String>? = null, gatewayType: Output<String>? = null, gatewayVpcEndpoint: Output<String>? = null, maintenanceStartTime: Output<GatewayMaintenanceStartTimeArgs>? = null, mediumChangerType: Output<String>? = null, smbActiveDirectorySettings: Output<GatewaySmbActiveDirectorySettingsArgs>? = null, smbFileShareVisibility: Output<Boolean>? = null, smbGuestPassword: Output<String>? = null, smbSecurityStrategy: Output<String>? = null, tags: Output<Map<String, String>>? = null, tapeDriveType: Output<String>? = null)

Properties

Link copied to clipboard
val activationKey: Output<String>? = null

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

Link copied to clipboard
val averageDownloadRateLimitInBitsPerSec: Output<Int>? = null

The average download bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.

Link copied to clipboard
val averageUploadRateLimitInBitsPerSec: Output<Int>? = null

The average upload bandwidth rate limit in bits per second. This is supported for the CACHED, STORED, and VTL gateway types.

Link copied to clipboard
val cloudwatchLogGroupArn: Output<String>? = null

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

Link copied to clipboard
val gatewayIpAddress: Output<String>? = null

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.

Link copied to clipboard
val gatewayName: Output<String>? = null

Name of the gateway.

Link copied to clipboard
val gatewayTimezone: Output<String>? = null

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.

Link copied to clipboard
val gatewayType: Output<String>? = null

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

Link copied to clipboard
val gatewayVpcEndpoint: Output<String>? = null

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.

Link copied to clipboard
val maintenanceStartTime: Output<GatewayMaintenanceStartTimeArgs>? = null

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.

Link copied to clipboard
val mediumChangerType: Output<String>? = null

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.

Link copied to clipboard
val smbActiveDirectorySettings: Output<GatewaySmbActiveDirectorySettingsArgs>? = null

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.

Link copied to clipboard
val smbFileShareVisibility: Output<Boolean>? = null

Specifies whether the shares on this gateway appear when listing shares.

Link copied to clipboard
val smbGuestPassword: Output<String>? = null

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.

Link copied to clipboard
val smbSecurityStrategy: Output<String>? = null

Specifies the type of security strategy. Valid values are: ClientSpecified, MandatorySigning, and MandatoryEncryption. See Setting a Security Level for Your Gateway for more information.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val tapeDriveType: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): GatewayArgs