-
Notifications
You must be signed in to change notification settings - Fork 17
/
CfnScalingPolicyProps.go
137 lines (134 loc) · 10.1 KB
/
CfnScalingPolicyProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
package awsapplicationautoscaling
// Properties for defining a `CfnScalingPolicy`.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// cfnScalingPolicyProps := &CfnScalingPolicyProps{
// PolicyName: jsii.String("policyName"),
// PolicyType: jsii.String("policyType"),
//
// // the properties below are optional
// ResourceId: jsii.String("resourceId"),
// ScalableDimension: jsii.String("scalableDimension"),
// ScalingTargetId: jsii.String("scalingTargetId"),
// ServiceNamespace: jsii.String("serviceNamespace"),
// StepScalingPolicyConfiguration: &StepScalingPolicyConfigurationProperty{
// AdjustmentType: jsii.String("adjustmentType"),
// Cooldown: jsii.Number(123),
// MetricAggregationType: jsii.String("metricAggregationType"),
// MinAdjustmentMagnitude: jsii.Number(123),
// StepAdjustments: []interface{}{
// &StepAdjustmentProperty{
// ScalingAdjustment: jsii.Number(123),
//
// // the properties below are optional
// MetricIntervalLowerBound: jsii.Number(123),
// MetricIntervalUpperBound: jsii.Number(123),
// },
// },
// },
// TargetTrackingScalingPolicyConfiguration: &TargetTrackingScalingPolicyConfigurationProperty{
// TargetValue: jsii.Number(123),
//
// // the properties below are optional
// CustomizedMetricSpecification: &CustomizedMetricSpecificationProperty{
// MetricName: jsii.String("metricName"),
// Namespace: jsii.String("namespace"),
// Statistic: jsii.String("statistic"),
//
// // the properties below are optional
// Dimensions: []interface{}{
// &MetricDimensionProperty{
// Name: jsii.String("name"),
// Value: jsii.String("value"),
// },
// },
// Unit: jsii.String("unit"),
// },
// DisableScaleIn: jsii.Boolean(false),
// PredefinedMetricSpecification: &PredefinedMetricSpecificationProperty{
// PredefinedMetricType: jsii.String("predefinedMetricType"),
//
// // the properties below are optional
// ResourceLabel: jsii.String("resourceLabel"),
// },
// ScaleInCooldown: jsii.Number(123),
// ScaleOutCooldown: jsii.Number(123),
// },
// }
//
type CfnScalingPolicyProps struct {
// The name of the scaling policy.
//
// Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing `AWS::ApplicationAutoScaling::ScalingPolicy` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
PolicyName *string `field:"required" json:"policyName" yaml:"policyName"`
// The scaling policy type.
//
// The following policy types are supported:
//
// `TargetTrackingScaling` —Not supported for Amazon EMR
//
// `StepScaling` —Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
PolicyType *string `field:"required" json:"policyType" yaml:"policyType"`
// 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](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource) .
// - 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` .
ResourceId *string `field:"optional" json:"resourceId" yaml:"resourceId"`
// 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.
ScalableDimension *string `field:"optional" json:"scalableDimension" yaml:"scalableDimension"`
// The CloudFormation-generated ID of an Application Auto Scaling scalable target.
//
// For more information about the ID, see the Return Value section of the `AWS::ApplicationAutoScaling::ScalableTarget` resource.
//
// > You must specify either the `ScalingTargetId` property, or the `ResourceId` , `ScalableDimension` , and `ServiceNamespace` properties, but not both.
ScalingTargetId *string `field:"optional" json:"scalingTargetId" yaml:"scalingTargetId"`
// The namespace of the AWS service that provides the resource, or a `custom-resource` .
ServiceNamespace *string `field:"optional" json:"serviceNamespace" yaml:"serviceNamespace"`
// A step scaling policy.
StepScalingPolicyConfiguration interface{} `field:"optional" json:"stepScalingPolicyConfiguration" yaml:"stepScalingPolicyConfiguration"`
// A target tracking scaling policy.
TargetTrackingScalingPolicyConfiguration interface{} `field:"optional" json:"targetTrackingScalingPolicyConfiguration" yaml:"targetTrackingScalingPolicyConfiguration"`
}