Class CreateDashboardRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest
software.amazon.awssdk.services.cloudtrail.model.CreateDashboardRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDashboardRequest extends CloudTrailRequest implements ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

  • Method Details

    • name

      public final String name()

      The name of the dashboard. The name must be unique to your account.

      To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

      Returns:
      The name of the dashboard. The name must be unique to your account.

      To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

    • refreshSchedule

      public final RefreshSchedule refreshSchedule()

      The refresh schedule configuration for the dashboard.

      To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

      Returns:
      The refresh schedule configuration for the dashboard.

      To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

    • hasTagsList

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

    • tagsList

      public final List<Tag> tagsList()
      Returns the value of the TagsList property for this object.

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

      Returns:
      The value of the TagsList property for this object.

    • terminationProtectionEnabled

      public final Boolean terminationProtectionEnabled()

      Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

      Returns:
      Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

    • hasWidgets

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

    • widgets

      public final List<RequestWidget> widgets()

      An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

      You do not need to specify widgets for the Highlights dashboard.

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

      Returns:
      An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

      You do not need to specify widgets for the Highlights dashboard.

    • toBuilder

      public CreateDashboardRequest.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<CreateDashboardRequest.Builder,CreateDashboardRequest>
      Specified by:
      toBuilder in class CloudTrailRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDashboardRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDashboardRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.