Package software.amazon.awssdk.services.applicationautoscaling.model

Class ScheduledAction

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

Represents a scheduled action.

See Also:

  • Method Details

    • scheduledActionName

      public final String scheduledActionName()

      The name of the scheduled action.

      Returns:
      The name of the scheduled action.

    • scheduledActionARN

      public final String scheduledActionARN()

      The Amazon Resource Name (ARN) of the scheduled action.

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

    • serviceNamespace

      public final ServiceNamespace serviceNamespace()

      The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

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

      Returns:
      The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
      See Also:

    • serviceNamespaceAsString

      public final String serviceNamespaceAsString()

      The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

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

      Returns:
      The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
      See Also:

    • schedule

      public final String schedule()

      The schedule for this action. The following formats are supported:

      • At expressions - "at(yyyy-mm-ddThh:mm:ss)"

      • Rate expressions - "rate(value unit)"

      • Cron expressions - "cron(fields)"

      At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.

      At and cron expressions use Universal Coordinated Time (UTC) by default.

      The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

      For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.

      Returns:
      The schedule for this action. The following formats are supported:

      • At expressions - "at(yyyy-mm-ddThh:mm:ss)"

      • Rate expressions - "rate(value unit)"

      • Cron expressions - "cron(fields)"

      At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.

      At and cron expressions use Universal Coordinated Time (UTC) by default.

      The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

      For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.

    • timezone

      public final String timezone()

      The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

      Returns:
      The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

    • resourceId

      public final String resourceId()

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      • Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

      • Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.

      • Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

      • SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.

      Returns:
      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      • Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .

      • Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.

      • Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

      • SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.

    • scalableDimension

      public final ScalableDimension scalableDimension()

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      • kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

      • elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

      • elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

      • neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

      • sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

      • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

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

      Returns:
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      • kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

      • elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

      • elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

      • neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

      • sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

      • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

      See Also:

    • scalableDimensionAsString

      public final String scalableDimensionAsString()

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      • kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

      • elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

      • elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

      • neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

      • sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

      • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

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

      Returns:
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      • kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

      • elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

      • elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

      • neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

      • sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

      • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

      See Also:

    • startTime

      public final Instant startTime()

      The date and time that the action is scheduled to begin, in UTC.

      Returns:
      The date and time that the action is scheduled to begin, in UTC.

    • endTime

      public final Instant endTime()

      The date and time that the action is scheduled to end, in UTC.

      Returns:
      The date and time that the action is scheduled to end, in UTC.

    • scalableTargetAction

      public final ScalableTargetAction scalableTargetAction()

      The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

      Returns:
      The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

    • creationTime

      public final Instant creationTime()

      The date and time that the scheduled action was created.

      Returns:
      The date and time that the scheduled action was created.

    • toBuilder

      public ScheduledAction.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<ScheduledAction.Builder,ScheduledAction>
      Returns:
      a builder for type T

    • builder

      public static ScheduledAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ScheduledAction.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.