public static interface ScalingPolicy.Builder extends SdkPojo, CopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
| Modifier and Type | Method and Description |
|---|---|
ScalingPolicy.Builder |
alarms(Alarm... alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy.Builder |
alarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy.Builder |
alarms(Consumer<Alarm.Builder>... alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy.Builder |
creationTime(Instant creationTime)
The Unix timestamp for when the scaling policy was created.
|
ScalingPolicy.Builder |
policyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
|
ScalingPolicy.Builder |
policyName(String policyName)
The name of the scaling policy.
|
ScalingPolicy.Builder |
policyType(PolicyType policyType)
The scaling policy type.
|
ScalingPolicy.Builder |
policyType(String policyType)
The scaling policy type.
|
ScalingPolicy.Builder |
resourceId(String resourceId)
The identifier of the resource associated with the scaling policy.
|
ScalingPolicy.Builder |
scalableDimension(ScalableDimension scalableDimension)
The scalable dimension.
|
ScalingPolicy.Builder |
scalableDimension(String scalableDimension)
The scalable dimension.
|
ScalingPolicy.Builder |
serviceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service that provides the resource, or a
custom-resource. |
ScalingPolicy.Builder |
serviceNamespace(String serviceNamespace)
The namespace of the AWS service that provides the resource, or a
custom-resource. |
default ScalingPolicy.Builder |
stepScalingPolicyConfiguration(Consumer<StepScalingPolicyConfiguration.Builder> stepScalingPolicyConfiguration)
A step scaling policy.
|
ScalingPolicy.Builder |
stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
|
default ScalingPolicy.Builder |
targetTrackingScalingPolicyConfiguration(Consumer<TargetTrackingScalingPolicyConfiguration.Builder> targetTrackingScalingPolicyConfiguration)
A target tracking scaling policy.
|
ScalingPolicy.Builder |
targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking scaling policy.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildScalingPolicy.Builder policyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
policyARN - The Amazon Resource Name (ARN) of the scaling policy.ScalingPolicy.Builder policyName(String policyName)
The name of the scaling policy.
policyName - The name of the scaling policy.ScalingPolicy.Builder serviceNamespace(String serviceNamespace)
The namespace of the AWS service that provides the resource, or a custom-resource.
serviceNamespace - The namespace of the AWS service that provides the resource, or a custom-resource.ServiceNamespace,
ServiceNamespaceScalingPolicy.Builder serviceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service that provides the resource, or a custom-resource.
serviceNamespace - The namespace of the AWS service that provides the resource, or a custom-resource.ServiceNamespace,
ServiceNamespaceScalingPolicy.Builder resourceId(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 request - 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.
Amazon 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
.
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 request - 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.
Amazon 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
.
ScalingPolicy.Builder scalableDimension(String 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.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
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 an Amazon 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.
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.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance
Group.
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 an Amazon
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.
ScalableDimension,
ScalableDimensionScalingPolicy.Builder scalableDimension(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.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
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 an Amazon 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.
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.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance
Group.
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 an Amazon
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.
ScalableDimension,
ScalableDimensionScalingPolicy.Builder policyType(String policyType)
The scaling policy type.
policyType - The scaling policy type.PolicyType,
PolicyTypeScalingPolicy.Builder policyType(PolicyType policyType)
The scaling policy type.
policyType - The scaling policy type.PolicyType,
PolicyTypeScalingPolicy.Builder stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
stepScalingPolicyConfiguration - A step scaling policy.default ScalingPolicy.Builder stepScalingPolicyConfiguration(Consumer<StepScalingPolicyConfiguration.Builder> stepScalingPolicyConfiguration)
A step scaling policy.
This is a convenience that creates an instance of theStepScalingPolicyConfiguration.Builder avoiding
the need to create one manually via StepScalingPolicyConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to
stepScalingPolicyConfiguration(StepScalingPolicyConfiguration).stepScalingPolicyConfiguration - a consumer that will call methods on StepScalingPolicyConfiguration.BuilderstepScalingPolicyConfiguration(StepScalingPolicyConfiguration)ScalingPolicy.Builder targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking scaling policy.
targetTrackingScalingPolicyConfiguration - A target tracking scaling policy.default ScalingPolicy.Builder targetTrackingScalingPolicyConfiguration(Consumer<TargetTrackingScalingPolicyConfiguration.Builder> targetTrackingScalingPolicyConfiguration)
A target tracking scaling policy.
This is a convenience that creates an instance of theTargetTrackingScalingPolicyConfiguration.Builder avoiding the need to create one manually via
TargetTrackingScalingPolicyConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to
targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration).targetTrackingScalingPolicyConfiguration - a consumer that will call methods on TargetTrackingScalingPolicyConfiguration.BuildertargetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration)ScalingPolicy.Builder alarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
alarms - The CloudWatch alarms associated with the scaling policy.ScalingPolicy.Builder alarms(Alarm... alarms)
The CloudWatch alarms associated with the scaling policy.
alarms - The CloudWatch alarms associated with the scaling policy.ScalingPolicy.Builder alarms(Consumer<Alarm.Builder>... alarms)
The CloudWatch alarms associated with the scaling policy.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #alarms(List) .alarms - a consumer that will call methods on List.Builder #alarms(List) ScalingPolicy.Builder creationTime(Instant creationTime)
The Unix timestamp for when the scaling policy was created.
creationTime - The Unix timestamp for when the scaling policy was created.Copyright © 2021. All rights reserved.