GatewayState class
Input properties used for looking up and filtering Gateway resources.
Constructors
-
GatewayState({Input<
String?> ? activationKey, Input<String?> ? arn, Input<int?> ? averageDownloadRateLimitInBitsPerSec, Input<int?> ? averageUploadRateLimitInBitsPerSec, Input<String?> ? cloudwatchLogGroupArn, Input<String?> ? ec2InstanceId, Input<String?> ? endpointType, Input<String?> ? gatewayId, Input<String?> ? gatewayIpAddress, Input<String?> ? gatewayName, Input<List< ? gatewayNetworkInterfaces, Input<GatewayGatewayNetworkInterface> ?>String?> ? gatewayTimezone, Input<String?> ? gatewayType, Input<String?> ? gatewayVpcEndpoint, Input<String?> ? hostEnvironment, Input<GatewayMaintenanceStartTime?> ? maintenanceStartTime, Input<String?> ? mediumChangerType, Input<String?> ? region, Input<GatewaySmbActiveDirectorySettings?> ? smbActiveDirectorySettings, Input<String?> ? smbGuestPassword, Input<String?> ? smbSecurityStrategy, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? tapeDriveType}) -
Creates a new GatewayState.
activationKeyGateway activation key during resource creation. Conflicts withgatewayIpAddress. Additional information is available in the Storage Gateway User Guide.arnARN of the gateway.averageDownloadRateLimitInBitsPerSecThe average download bandwidth rate limit in bits per second. This is supported for theCACHED,STORED, andVTLgateway types.averageUploadRateLimitInBitsPerSecThe average upload bandwidth rate limit in bits per second. This is supported for theCACHED,STORED, andVTLgateway types.cloudwatchLogGroupArnARN of the Amazon CloudWatch log group to use to monitor and log events in the gateway.ec2InstanceIdThe ID of the Amazon EC2 instance that was used to launch the gateway.endpointTypeThe type of endpoint for your gateway.gatewayIdIdentifier of the gateway.gatewayIpAddressGateway IP address to retrieve activation key during resource creation. Conflicts withactivationKey. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.gatewayNameName of the gateway.gatewayNetworkInterfacesAn array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.gatewayTimezoneTime zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example,GMT-4:00indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.gatewayTypeType of the gateway. The default value isSTORED. Valid values:CACHED,FILE_FSX_SMB,FILE_S3,STORED,VTL.gatewayVpcEndpointVPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running Pulumi. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a VPC.hostEnvironmentThe type of hypervisor environment used by the host.maintenanceStartTimeThe 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.mediumChangerTypeType 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.smbActiveDirectorySettingsNested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid forFILE_S3andFILE_FSX_SMBgateway types. Must be set before creatingActiveDirectoryauthentication SMB file shares. More details below.smbFileShareVisibilitySpecifies whether the shares on this gateway appear when listing shares.smbGuestPasswordGuest password for Server Message Block (SMB) file shares. Only valid forFILE_S3andFILE_FSX_SMBgateway types. Must be set before creatingGuestAccessauthentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.smbSecurityStrategySpecifies the type of security strategy. Valid values are:ClientSpecified,MandatorySigning, andMandatoryEncryption. See Setting a Security Level for Your Gateway for more information.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.tapeDriveTypeType of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values:IBM-ULT3580-TD5.const -
GatewayState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
activationKey
→ Input<
String?> ? -
Gateway activation key during resource creation. Conflicts with
gatewayIpAddress. Additional information is available in the Storage Gateway User Guide.final -
arn
→ Input<
String?> ? -
ARN of the gateway.
final
-
averageDownloadRateLimitInBitsPerSec
→ Input<
int?> ? -
The average download bandwidth rate limit in bits per second. This is supported for the
CACHED,STORED, andVTLgateway types.final -
averageUploadRateLimitInBitsPerSec
→ Input<
int?> ? -
The average upload bandwidth rate limit in bits per second. This is supported for the
CACHED,STORED, andVTLgateway types.final -
cloudwatchLogGroupArn
→ Input<
String?> ? -
ARN of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
final
-
ec2InstanceId
→ Input<
String?> ? -
The ID of the Amazon EC2 instance that was used to launch the gateway.
final
-
endpointType
→ Input<
String?> ? -
The type of endpoint for your gateway.
final
-
gatewayId
→ Input<
String?> ? -
Identifier of the gateway.
final
-
gatewayIpAddress
→ Input<
String?> ? -
Gateway IP address to retrieve activation key during resource creation. Conflicts with
activationKey. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.final -
gatewayName
→ Input<
String?> ? -
Name of the gateway.
final
-
gatewayNetworkInterfaces
→ Input<
List< ?GatewayGatewayNetworkInterface> ?> -
An array that contains descriptions of the gateway network interfaces. See Gateway Network Interface.
final
-
gatewayTimezone
→ Input<
String?> ? -
Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example,
GMT-4:00indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.final -
gatewayType
→ Input<
String?> ? -
Type of the gateway. The default value is
STORED. Valid values:CACHED,FILE_FSX_SMB,FILE_S3,STORED,VTL.final -
gatewayVpcEndpoint
→ Input<
String?> ? -
VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running Pulumi. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a VPC.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hostEnvironment
→ Input<
String?> ? -
The type of hypervisor environment used by the host.
final
-
maintenanceStartTime
→ Input<
GatewayMaintenanceStartTime?> ? -
The gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. More details below.
final
-
mediumChangerType
→ Input<
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.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
smbActiveDirectorySettings
→ Input<
GatewaySmbActiveDirectorySettings?> ? -
Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for
FILE_S3andFILE_FSX_SMBgateway types. Must be set before creatingActiveDirectoryauthentication SMB file shares. More details below.final -
Specifies whether the shares on this gateway appear when listing shares.
final
-
smbGuestPassword
→ Input<
String?> ? -
Guest password for Server Message Block (SMB) file shares. Only valid for
FILE_S3andFILE_FSX_SMBgateway types. Must be set before creatingGuestAccessauthentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.final -
smbSecurityStrategy
→ Input<
String?> ? -
Specifies the type of security strategy. Valid values are:
ClientSpecified,MandatorySigning, andMandatoryEncryption. See Setting a Security Level for Your Gateway for more information.final -
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
tapeDriveType
→ Input<
String?> ? -
Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values:
IBM-ULT3580-TD5.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited