DescribedSecurityPolicy - AWS Transfer Family

DescribedSecurityPolicy

Describes the properties of a security policy that you specify. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

Contents

SecurityPolicyName

The text name of the specified security policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+

Required: Yes

Fips

Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.

Type: Boolean

Required: No

Protocols

Lists the file transfer protocols that the security policy applies to.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Valid Values: SFTP | FTPS

Required: No

SshCiphers

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.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 50.

Required: No

SshHostKeyAlgorithms

Lists the host key algorithms for the security policy.

Note

This parameter only applies to security policies for connectors.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 50.

Required: No

SshKexs

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.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 50.

Required: No

SshMacs

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.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 50.

Required: No

TlsCiphers

Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

Note

This parameter only applies to security policies for servers.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 50.

Required: No

Type

The resource type to which the security policy applies, either server or connector.

Type: String

Valid Values: SERVER | CONNECTOR

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: