Skip to content

DescribedSecurityPolicy

Source code in docs_src/capo_transfer/types/described_security_policy.py
class DescribedSecurityPolicy(TypedDict, closed=True):
    fips: NotRequired["capo_transfer.types.fips.Fips"]
    """<p>Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.</p>"""
    security_policy_name: "capo_transfer.types.security_policy_name.SecurityPolicyName"
    """<p>The text name of the specified security policy.</p>"""
    ssh_ciphers: NotRequired[
        "capo_transfer.types.security_policy_options.SecurityPolicyOptions"
    ]
    """<p>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.</p>"""
    ssh_kexs: NotRequired[
        "capo_transfer.types.security_policy_options.SecurityPolicyOptions"
    ]
    """<p>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.</p>"""
    ssh_macs: NotRequired[
        "capo_transfer.types.security_policy_options.SecurityPolicyOptions"
    ]
    """<p>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.</p>"""
    tls_ciphers: NotRequired[
        "capo_transfer.types.security_policy_options.SecurityPolicyOptions"
    ]
    """<p>Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.</p> <note> <p>This parameter only applies to security policies for servers.</p> </note>"""
    ssh_host_key_algorithms: NotRequired[
        "capo_transfer.types.security_policy_options.SecurityPolicyOptions"
    ]
    """<p>Lists the host key algorithms for the security policy.</p> <note> <p>This parameter only applies to security policies for connectors.</p> </note>"""
    type: NotRequired[
        "capo_transfer.types.security_policy_resource_type.SecurityPolicyResourceType"
    ]
    """<p>The resource type to which the security policy applies, either server or connector.</p>"""
    protocols: NotRequired[
        "capo_transfer.types.security_policy_protocols.SecurityPolicyProtocols"
    ]
    """<p>Lists the file transfer protocols that the security policy applies to.</p>"""

fips instance-attribute

fips: NotRequired[Fips]

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

protocols instance-attribute

protocols: NotRequired[SecurityPolicyProtocols]

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

security_policy_name instance-attribute

security_policy_name: SecurityPolicyName

The text name of the specified security policy.

ssh_ciphers instance-attribute

ssh_ciphers: NotRequired[SecurityPolicyOptions]

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 instance-attribute

ssh_host_key_algorithms: NotRequired[SecurityPolicyOptions]

Lists the host key algorithms for the security policy.

This parameter only applies to security policies for connectors.

ssh_kexs instance-attribute

ssh_kexs: NotRequired[SecurityPolicyOptions]

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 instance-attribute

ssh_macs: NotRequired[SecurityPolicyOptions]

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 instance-attribute

tls_ciphers: NotRequired[SecurityPolicyOptions]

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 instance-attribute

type: NotRequired[SecurityPolicyResourceType]

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