DescribedSecurityPolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedSecurityPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedSecurityPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedSecurityPolicy()

Constructors
Constructor and Description
`DescribedSecurityPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedSecurityPolicy`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getFips()` Specifies whether this policy enables Federal Information Processing Standards (FIPS).
`List<String>`	`getProtocols()` Lists the file transfer protocols that the security policy applies to.
`String`	`getSecurityPolicyName()` The text name of the specified security policy.
`List<String>`	`getSshCiphers()` Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector.
`List<String>`	`getSshHostKeyAlgorithms()` Lists the host key algorithms for the security policy.
`List<String>`	`getSshKexs()` Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector.
`List<String>`	`getSshMacs()` Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector.
`List<String>`	`getTlsCiphers()` Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
`String`	`getType()` The resource type to which the security policy applies, either server or connector.
`int`	`hashCode()`
`Boolean`	`isFips()` Specifies whether this policy enables Federal Information Processing Standards (FIPS).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFips(Boolean fips)` Specifies whether this policy enables Federal Information Processing Standards (FIPS).
`void`	`setProtocols(Collection<String> protocols)` Lists the file transfer protocols that the security policy applies to.
`void`	`setSecurityPolicyName(String securityPolicyName)` The text name of the specified security policy.
`void`	`setSshCiphers(Collection<String> sshCiphers)` Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector.
`void`	`setSshHostKeyAlgorithms(Collection<String> sshHostKeyAlgorithms)` Lists the host key algorithms for the security policy.
`void`	`setSshKexs(Collection<String> sshKexs)` Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector.
`void`	`setSshMacs(Collection<String> sshMacs)` Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector.
`void`	`setTlsCiphers(Collection<String> tlsCiphers)` Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
`void`	`setType(String type)` The resource type to which the security policy applies, either server or connector.
`String`	`toString()` Returns a string representation of this object.
`DescribedSecurityPolicy`	`withFips(Boolean fips)` Specifies whether this policy enables Federal Information Processing Standards (FIPS).
`DescribedSecurityPolicy`	`withProtocols(Collection<String> protocols)` Lists the file transfer protocols that the security policy applies to.
`DescribedSecurityPolicy`	`withProtocols(SecurityPolicyProtocol... protocols)` Lists the file transfer protocols that the security policy applies to.
`DescribedSecurityPolicy`	`withProtocols(String... protocols)` Lists the file transfer protocols that the security policy applies to.
`DescribedSecurityPolicy`	`withSecurityPolicyName(String securityPolicyName)` The text name of the specified security policy.
`DescribedSecurityPolicy`	`withSshCiphers(Collection<String> sshCiphers)` Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector.
`DescribedSecurityPolicy`	`withSshCiphers(String... sshCiphers)` Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector.
`DescribedSecurityPolicy`	`withSshHostKeyAlgorithms(Collection<String> sshHostKeyAlgorithms)` Lists the host key algorithms for the security policy.
`DescribedSecurityPolicy`	`withSshHostKeyAlgorithms(String... sshHostKeyAlgorithms)` Lists the host key algorithms for the security policy.
`DescribedSecurityPolicy`	`withSshKexs(Collection<String> sshKexs)` Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector.
`DescribedSecurityPolicy`	`withSshKexs(String... sshKexs)` Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector.
`DescribedSecurityPolicy`	`withSshMacs(Collection<String> sshMacs)` Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector.
`DescribedSecurityPolicy`	`withSshMacs(String... sshMacs)` Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector.
`DescribedSecurityPolicy`	`withTlsCiphers(Collection<String> tlsCiphers)` Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
`DescribedSecurityPolicy`	`withTlsCiphers(String... tlsCiphers)` Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
`DescribedSecurityPolicy`	`withType(SecurityPolicyResourceType type)` The resource type to which the security policy applies, either server or connector.
`DescribedSecurityPolicy`	`withType(String type)` The resource type to which the security policy applies, either server or connector.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedSecurityPolicy
```
public DescribedSecurityPolicy()
```
- Method Detail
  - setFips
```
public void setFips(Boolean fips)
```
    Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
    
    Parameters:
    
    fips - Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
  - getFips
```
public Boolean getFips()
```
    Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
    
    Returns:
    
    Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
  - withFips
```
public DescribedSecurityPolicy withFips(Boolean fips)
```
    Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
    
    Parameters:
    
    fips - Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFips
```
public Boolean isFips()
```
    Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
    
    Returns:
    
    Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.
  - setSecurityPolicyName
```
public void setSecurityPolicyName(String securityPolicyName)
```
    The text name of the specified security policy.
    
    Parameters:
    
    securityPolicyName - The text name of the specified security policy.
  - getSecurityPolicyName
```
public String getSecurityPolicyName()
```
    The text name of the specified security policy.
    
    Returns:
    
    The text name of the specified security policy.
  - withSecurityPolicyName
```
public DescribedSecurityPolicy withSecurityPolicyName(String securityPolicyName)
```
    The text name of the specified security policy.
    
    Parameters:
    
    securityPolicyName - The text name of the specified security policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSshCiphers
```
public List<String> getSshCiphers()
```
    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.
    
    Returns:
    
    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.
  - setSshCiphers
```
public void setSshCiphers(Collection<String> 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.
    
    Parameters:
    
    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.
  - withSshCiphers
```
public DescribedSecurityPolicy withSshCiphers(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSshCiphers(java.util.Collection) or withSshCiphers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSshCiphers
```
public DescribedSecurityPolicy withSshCiphers(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSshKexs
```
public List<String> getSshKexs()
```
    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.
    
    Returns:
    
    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.
  - setSshKexs
```
public void setSshKexs(Collection<String> 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.
    
    Parameters:
    
    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.
  - withSshKexs
```
public DescribedSecurityPolicy withSshKexs(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSshKexs(java.util.Collection) or withSshKexs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSshKexs
```
public DescribedSecurityPolicy withSshKexs(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSshMacs
```
public List<String> getSshMacs()
```
    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.
    
    Returns:
    
    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.
  - setSshMacs
```
public void setSshMacs(Collection<String> 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.
    
    Parameters:
    
    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.
  - withSshMacs
```
public DescribedSecurityPolicy withSshMacs(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSshMacs(java.util.Collection) or withSshMacs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSshMacs
```
public DescribedSecurityPolicy withSshMacs(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTlsCiphers
```
public List<String> getTlsCiphers()
```
    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.
    
    Returns:
    
    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.
  - setTlsCiphers
```
public void setTlsCiphers(Collection<String> tlsCiphers)
```
    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.
    
    Parameters:
    
    tlsCiphers - 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.
  - withTlsCiphers
```
public DescribedSecurityPolicy withTlsCiphers(String... tlsCiphers)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTlsCiphers(java.util.Collection) or withTlsCiphers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tlsCiphers - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTlsCiphers
```
public DescribedSecurityPolicy withTlsCiphers(Collection<String> tlsCiphers)
```
    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.
    
    Parameters:
    
    tlsCiphers - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSshHostKeyAlgorithms
```
public List<String> getSshHostKeyAlgorithms()
```
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    Returns:
    
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
  - setSshHostKeyAlgorithms
```
public void setSshHostKeyAlgorithms(Collection<String> sshHostKeyAlgorithms)
```
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    Parameters:
    
    sshHostKeyAlgorithms - Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
  - withSshHostKeyAlgorithms
```
public DescribedSecurityPolicy withSshHostKeyAlgorithms(String... sshHostKeyAlgorithms)
```
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    NOTE: This method appends the values to the existing list (if any). Use setSshHostKeyAlgorithms(java.util.Collection) or withSshHostKeyAlgorithms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sshHostKeyAlgorithms - Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSshHostKeyAlgorithms
```
public DescribedSecurityPolicy withSshHostKeyAlgorithms(Collection<String> sshHostKeyAlgorithms)
```
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    Parameters:
    
    sshHostKeyAlgorithms - Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The resource type to which the security policy applies, either server or connector.
    
    Parameters:
    
    type - The resource type to which the security policy applies, either server or connector.
    
    See Also:
    
    SecurityPolicyResourceType
  - getType
```
public String getType()
```
    The resource type to which the security policy applies, either server or connector.
    
    Returns:
    
    The resource type to which the security policy applies, either server or connector.
    
    See Also:
    
    SecurityPolicyResourceType
  - withType
```
public DescribedSecurityPolicy withType(String type)
```
    The resource type to which the security policy applies, either server or connector.
    
    Parameters:
    
    type - The resource type to which the security policy applies, either server or connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicyResourceType
  - withType
```
public DescribedSecurityPolicy withType(SecurityPolicyResourceType type)
```
    The resource type to which the security policy applies, either server or connector.
    
    Parameters:
    
    type - The resource type to which the security policy applies, either server or connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicyResourceType
  - getProtocols
```
public List<String> getProtocols()
```
    Lists the file transfer protocols that the security policy applies to.
    
    Returns:
    
    Lists the file transfer protocols that the security policy applies to.
    
    See Also:
    
    SecurityPolicyProtocol
  - setProtocols
```
public void setProtocols(Collection<String> protocols)
```
    Lists the file transfer protocols that the security policy applies to.
    
    Parameters:
    
    protocols - Lists the file transfer protocols that the security policy applies to.
    
    See Also:
    
    SecurityPolicyProtocol
  - withProtocols
```
public DescribedSecurityPolicy withProtocols(String... protocols)
```
    Lists the file transfer protocols that the security policy applies to.
    
    NOTE: This method appends the values to the existing list (if any). Use setProtocols(java.util.Collection) or withProtocols(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    protocols - Lists the file transfer protocols that the security policy applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicyProtocol
  - withProtocols
```
public DescribedSecurityPolicy withProtocols(Collection<String> protocols)
```
    Lists the file transfer protocols that the security policy applies to.
    
    Parameters:
    
    protocols - Lists the file transfer protocols that the security policy applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicyProtocol
  - withProtocols
```
public DescribedSecurityPolicy withProtocols(SecurityPolicyProtocol... protocols)
```
    Lists the file transfer protocols that the security policy applies to.
    
    Parameters:
    
    protocols - Lists the file transfer protocols that the security policy applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicyProtocol
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribedSecurityPolicy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class DescribedSecurityPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedSecurityPolicy

Method Detail

setFips

getFips

withFips

isFips

setSecurityPolicyName

getSecurityPolicyName

withSecurityPolicyName

getSshCiphers

setSshCiphers

withSshCiphers

withSshCiphers

getSshKexs

setSshKexs

withSshKexs

withSshKexs

getSshMacs

setSshMacs

withSshMacs

withSshMacs

getTlsCiphers

setTlsCiphers

withTlsCiphers

withTlsCiphers

getSshHostKeyAlgorithms

setSshHostKeyAlgorithms

withSshHostKeyAlgorithms

withSshHostKeyAlgorithms

setType

getType

withType

withType

getProtocols

setProtocols

withProtocols

withProtocols

withProtocols

toString

equals

hashCode

clone

marshall