smb_settings

Creates, updates, deletes, gets or lists a smb_settings resource.

Overview

Name	smb_settings
Type	Resource
Id	aws.storagegateway.smb_settings

Fields

The following fields are returned by SELECT queries:

describe_smb_settings

Name	Datatype	Description
active_directory_status	string	Indicates the status of a gateway that is a member of the Active Directory domain. This field is only used as part of a JoinDomain request. It is not affected by Active Directory connectivity changes that occur after the JoinDomain request succeeds. ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error. DETACHED: Indicates that gateway is not joined to a domain. JOINED: Indicates that the gateway has successfully joined a domain. JOINING: Indicates that a JoinDomain operation is in progress. NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error. TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time. UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error. (ACCESS_DENIED, DETACHED, JOINED, JOINING, NETWORK_ERROR, TIMEOUT, UNKNOWN_ERROR, INSUFFICIENT_PERMISSIONS)
domain_name	string	The name of the domain that the gateway is joined to. (pattern: <code>^([a-zA-Z0-9]+[\.-])+([a-zA-Z0-9])+$</code>)
file_shares_visible	boolean	The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
smb_guest_password_set	boolean	This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways. Valid Values: true | false
smb_local_groups	object	A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
smb_security_strategy	string	The type of security strategy that was specified for file gateway. ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway. MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later. MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later. MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later. (ClientSpecified, MandatorySigning, MandatoryEncryption, MandatoryEncryptionNoAes128)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_smb_settings	select	region		Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_smb_settings

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

SELECT
active_directory_status,
domain_name,
file_shares_visible,
gateway_arn,
smb_guest_password_set,
smb_local_groups,
smb_security_strategy
FROM aws.storagegateway.smb_settings
WHERE region = '{{ region }}' -- required
;