Class ControlSummary

java.lang.Object
software.amazon.awssdk.services.controlcatalog.model.ControlSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ControlSummary.Builder,ControlSummary>
@Generated("software.amazon.awssdk:codegen") public final class ControlSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ControlSummary.Builder,ControlSummary>

Overview of information about a control.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the control.

      Returns:
      The Amazon Resource Name (ARN) of the control.

    • hasAliases

      public final boolean hasAliases()
      For responses, this returns true if the service returned a value for the Aliases 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.

    • aliases

      public final List<String> aliases()

      A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.

      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 hasAliases() method.

      Returns:
      A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.

    • name

      public final String name()

      The display name of the control.

      Returns:
      The display name of the control.

    • description

      public final String description()

      A description of the control, as it may appear in the console. Describes the functionality of the control.

      Returns:
      A description of the control, as it may appear in the console. Describes the functionality of the control.

    • behavior

      public final ControlBehavior behavior()

      An enumerated type, with the following possible values:

      If the service returns an enum value that is not available in the current SDK version, behavior will return ControlBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from behaviorAsString().

      Returns:
      An enumerated type, with the following possible values:
      See Also:

    • behaviorAsString

      public final String behaviorAsString()

      An enumerated type, with the following possible values:

      If the service returns an enum value that is not available in the current SDK version, behavior will return ControlBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from behaviorAsString().

      Returns:
      An enumerated type, with the following possible values:
      See Also:

    • severity

      public final ControlSeverity severity()

      An enumerated type, with the following possible values:

      If the service returns an enum value that is not available in the current SDK version, severity will return ControlSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

      Returns:
      An enumerated type, with the following possible values:
      See Also:

    • severityAsString

      public final String severityAsString()

      An enumerated type, with the following possible values:

      If the service returns an enum value that is not available in the current SDK version, severity will return ControlSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

      Returns:
      An enumerated type, with the following possible values:
      See Also:

    • parameterRequirementSummary

      public final ParameterRequirementSummary parameterRequirementSummary()

      A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.

      If the service returns an enum value that is not available in the current SDK version, parameterRequirementSummary will return ParameterRequirementSummary.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parameterRequirementSummaryAsString().

      Returns:
      A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.
      See Also:

    • parameterRequirementSummaryAsString

      public final String parameterRequirementSummaryAsString()

      A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.

      If the service returns an enum value that is not available in the current SDK version, parameterRequirementSummary will return ParameterRequirementSummary.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parameterRequirementSummaryAsString().

      Returns:
      A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.
      See Also:

    • implementation

      public final ImplementationSummary implementation()

      An object of type ImplementationSummary that describes how the control is implemented.

      Returns:
      An object of type ImplementationSummary that describes how the control is implemented.

    • createTime

      public final Instant createTime()

      A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

      Returns:
      A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

    • hasGovernedResources

      public final boolean hasGovernedResources()
      For responses, this returns true if the service returned a value for the GovernedResources 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.

    • governedResources

      public final List<String> governedResources()

      A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If GovernedResources cannot be represented by available resource types, it’s returned as an empty list.

      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 hasGovernedResources() method.

      Returns:
      A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If GovernedResources cannot be represented by available resource types, it’s returned as an empty list.

    • hasGovernedProviders

      public final boolean hasGovernedProviders()
      For responses, this returns true if the service returned a value for the GovernedProviders 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.

    • governedProviders

      public final List<String> governedProviders()

      A list of providers whose resources are governed by this control. For example, a value of AWS indicates that the control governs Amazon Web Services resources.

      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 hasGovernedProviders() method.

      Returns:
      A list of providers whose resources are governed by this control. For example, a value of AWS indicates that the control governs Amazon Web Services resources.

    • toBuilder

      public ControlSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ControlSummary.Builder,ControlSummary>
      Returns:
      a builder for type T

    • builder

      public static ControlSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ControlSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.