security_policies

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

Overview

Name	security_policies
Type	Resource
Id	aws.transfer.security_policies

Fields

The following fields are returned by SELECT queries:

describe_security_policy

Name	Datatype	Description
fips	boolean	Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
protocols	array	Lists the file transfer protocols that the security policy applies to.
security_policy_name	string	The text name of the specified security policy. (pattern: <code>Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+</code>)
ssh_ciphers	array	Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.
ssh_host_key_algorithms	array	Lists the host key algorithms for the security policy. This parameter only applies to security policies for connectors.
ssh_kexs	array	Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.
ssh_macs	array	Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.
tls_ciphers	array	Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server. This parameter only applies to security policies for servers.
type	string	The resource type to which the security policy applies, either server or connector. (SERVER, CONNECTOR)

list_security_policies

Name	Datatype	Description
security_policy_name	string	An array of security policies that were listed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_security_policy	select	region		Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
list_security_policies	select	region		Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

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_security_policy

Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

SELECT
fips,
protocols,
security_policy_name,
ssh_ciphers,
ssh_host_key_algorithms,
ssh_kexs,
ssh_macs,
tls_ciphers,
type
FROM aws.transfer.security_policies
WHERE region = '{{ region }}' -- required
;

list_security_policies

Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

SELECT
security_policy_name
FROM aws.transfer.security_policies
WHERE region = '{{ region }}' -- required
;