/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the application-autoscaling-2016-02-06.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.ApplicationAutoScaling.Model
{
///
/// Represents a scheduled action.
///
public partial class ScheduledAction
{
private DateTime? _creationTime;
private DateTime? _endTime;
private string _resourceId;
private ScalableDimension _scalableDimension;
private ScalableTargetAction _scalableTargetAction;
private string _schedule;
private string _scheduledActionARN;
private string _scheduledActionName;
private ServiceNamespace _serviceNamespace;
private DateTime? _startTime;
private string _timezone;
///
/// Gets and sets the property CreationTime.
///
/// The date and time that the scheduled action was created.
///
///
[AWSProperty(Required=true)]
public DateTime CreationTime
{
get { return this._creationTime.GetValueOrDefault(); }
set { this._creationTime = value; }
}
// Check to see if CreationTime property is set
internal bool IsSetCreationTime()
{
return this._creationTime.HasValue;
}
///
/// Gets and sets the property EndTime.
///
/// The date and time that the action is scheduled to end, in UTC.
///
///
public DateTime EndTime
{
get { return this._endTime.GetValueOrDefault(); }
set { this._endTime = value; }
}
// Check to see if EndTime property is set
internal bool IsSetEndTime()
{
return this._endTime.HasValue;
}
///
/// Gets and sets the property 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
.
///
///
///
[AWSProperty(Required=true, Min=1, Max=1600)]
public string ResourceId
{
get { return this._resourceId; }
set { this._resourceId = value; }
}
// Check to see if ResourceId property is set
internal bool IsSetResourceId()
{
return this._resourceId != null;
}
///
/// Gets and sets the property 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.
///
///
///
public ScalableDimension ScalableDimension
{
get { return this._scalableDimension; }
set { this._scalableDimension = value; }
}
// Check to see if ScalableDimension property is set
internal bool IsSetScalableDimension()
{
return this._scalableDimension != null;
}
///
/// Gets and sets the property 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.
///
///
public ScalableTargetAction ScalableTargetAction
{
get { return this._scalableTargetAction; }
set { this._scalableTargetAction = value; }
}
// Check to see if ScalableTargetAction property is set
internal bool IsSetScalableTargetAction()
{
return this._scalableTargetAction != null;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Required=true, Min=1, Max=1600)]
public string Schedule
{
get { return this._schedule; }
set { this._schedule = value; }
}
// Check to see if Schedule property is set
internal bool IsSetSchedule()
{
return this._schedule != null;
}
///
/// Gets and sets the property ScheduledActionARN.
///
/// The Amazon Resource Name (ARN) of the scheduled action.
///
///
[AWSProperty(Required=true, Min=1, Max=1600)]
public string ScheduledActionARN
{
get { return this._scheduledActionARN; }
set { this._scheduledActionARN = value; }
}
// Check to see if ScheduledActionARN property is set
internal bool IsSetScheduledActionARN()
{
return this._scheduledActionARN != null;
}
///
/// Gets and sets the property ScheduledActionName.
///
/// The name of the scheduled action.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string ScheduledActionName
{
get { return this._scheduledActionName; }
set { this._scheduledActionName = value; }
}
// Check to see if ScheduledActionName property is set
internal bool IsSetScheduledActionName()
{
return this._scheduledActionName != null;
}
///
/// Gets and sets the property ServiceNamespace.
///
/// The namespace of the Amazon Web Services service that provides the resource, or a
/// custom-resource
.
///
///
[AWSProperty(Required=true)]
public ServiceNamespace ServiceNamespace
{
get { return this._serviceNamespace; }
set { this._serviceNamespace = value; }
}
// Check to see if ServiceNamespace property is set
internal bool IsSetServiceNamespace()
{
return this._serviceNamespace != null;
}
///
/// Gets and sets the property StartTime.
///
/// The date and time that the action is scheduled to begin, in UTC.
///
///
public DateTime StartTime
{
get { return this._startTime.GetValueOrDefault(); }
set { this._startTime = value; }
}
// Check to see if StartTime property is set
internal bool IsSetStartTime()
{
return this._startTime.HasValue;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Min=1, Max=1600)]
public string Timezone
{
get { return this._timezone; }
set { this._timezone = value; }
}
// Check to see if Timezone property is set
internal bool IsSetTimezone()
{
return this._timezone != null;
}
}
}