java.lang.Object
- software.amazon.awssdk.services.transfer.model.DescribedSecurityPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedSecurityPolicy.Builder,DescribedSecurityPolicy>
```
@Generated("software.amazon.awssdk:codegen")
public final class DescribedSecurityPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribedSecurityPolicy.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribedSecurityPolicy.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribedSecurityPolicy.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`fips()`	Specifies whether this policy enables Federal Information Processing Standards (FIPS).
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProtocols()`	For responses, this returns true if the service returned a value for the Protocols property.
`boolean`	`hasSshCiphers()`	For responses, this returns true if the service returned a value for the SshCiphers property.
`boolean`	`hasSshHostKeyAlgorithms()`	For responses, this returns true if the service returned a value for the SshHostKeyAlgorithms property.
`boolean`	`hasSshKexs()`	For responses, this returns true if the service returned a value for the SshKexs property.
`boolean`	`hasSshMacs()`	For responses, this returns true if the service returned a value for the SshMacs property.
`boolean`	`hasTlsCiphers()`	For responses, this returns true if the service returned a value for the TlsCiphers property.
`List<SecurityPolicyProtocol>`	`protocols()`	Lists the file transfer protocols that the security policy applies to.
`List<String>`	`protocolsAsStrings()`	Lists the file transfer protocols that the security policy applies to.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityPolicyName()`	The text name of the specified security policy.
`static Class<? extends DescribedSecurityPolicy.Builder>`	`serializableBuilderClass()`
`List<String>`	`sshCiphers()`	Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector.
`List<String>`	`sshHostKeyAlgorithms()`	Lists the host key algorithms for the security policy.
`List<String>`	`sshKexs()`	Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector.
`List<String>`	`sshMacs()`	Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector.
`List<String>`	`tlsCiphers()`	Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
`DescribedSecurityPolicy.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`SecurityPolicyResourceType`	`type()`	The resource type to which the security policy applies, either server or connector.
`String`	`typeAsString()`	The resource type to which the security policy applies, either server or connector.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - fips
```
public final Boolean fips()
```
    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.
  - securityPolicyName
```
public final String securityPolicyName()
```
    The text name of the specified security policy.
    
    Returns:
    
    The text name of the specified security policy.
  - hasSshCiphers
```
public final boolean hasSshCiphers()
```
    For responses, this returns true if the service returned a value for the SshCiphers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sshCiphers
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSshCiphers() method.
    
    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.
  - hasSshKexs
```
public final boolean hasSshKexs()
```
    For responses, this returns true if the service returned a value for the SshKexs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sshKexs
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSshKexs() method.
    
    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.
  - hasSshMacs
```
public final boolean hasSshMacs()
```
    For responses, this returns true if the service returned a value for the SshMacs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sshMacs
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSshMacs() method.
    
    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.
  - hasTlsCiphers
```
public final boolean hasTlsCiphers()
```
    For responses, this returns true if the service returned a value for the TlsCiphers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tlsCiphers
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTlsCiphers() method.
    
    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.
  - hasSshHostKeyAlgorithms
```
public final boolean hasSshHostKeyAlgorithms()
```
    For responses, this returns true if the service returned a value for the SshHostKeyAlgorithms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sshHostKeyAlgorithms
```
public final List<String> sshHostKeyAlgorithms()
```
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSshHostKeyAlgorithms() method.
    
    Returns:
    
    Lists the host key algorithms for the security policy.
    
    This parameter only applies to security policies for connectors.
  - type
```
public final SecurityPolicyResourceType type()
```
    The resource type to which the security policy applies, either server or connector.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SecurityPolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The resource type to which the security policy applies, either server or connector.
    
    See Also:
    
    SecurityPolicyResourceType
  - typeAsString
```
public final String typeAsString()
```
    The resource type to which the security policy applies, either server or connector.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SecurityPolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The resource type to which the security policy applies, either server or connector.
    
    See Also:
    
    SecurityPolicyResourceType
  - protocols
```
public final List<SecurityPolicyProtocol> protocols()
```
    Lists the file transfer protocols that the security policy applies to.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.
    
    Returns:
    
    Lists the file transfer protocols that the security policy applies to.
  - hasProtocols
```
public final boolean hasProtocols()
```
    For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - protocolsAsStrings
```
public final List<String> protocolsAsStrings()
```
    Lists the file transfer protocols that the security policy applies to.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.
    
    Returns:
    
    Lists the file transfer protocols that the security policy applies to.
  - toBuilder
```
public DescribedSecurityPolicy.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribedSecurityPolicy.Builder,DescribedSecurityPolicy>
  - builder
```
public static DescribedSecurityPolicy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribedSecurityPolicy.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribedSecurityPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fips

securityPolicyName

hasSshCiphers

sshCiphers

hasSshKexs

sshKexs

hasSshMacs

sshMacs

hasTlsCiphers

tlsCiphers

hasSshHostKeyAlgorithms

sshHostKeyAlgorithms

type

typeAsString

protocols

hasProtocols

protocolsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField