@Stability(value=Stable) public static final class CfnScalableTargetProps.Builder extends Object implements software.amazon.jsii.Builder<CfnScalableTargetProps>
CfnScalableTargetProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnScalableTargetProps.Builder maxCapacity(Number maxCapacity)
CfnScalableTargetProps.getMaxCapacity()maxCapacity - The maximum value that you plan to scale out to. This parameter is required.
When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.this@Stability(value=Stable) public CfnScalableTargetProps.Builder minCapacity(Number minCapacity)
CfnScalableTargetProps.getMinCapacity()minCapacity - The minimum value that you plan to scale in to. This parameter is required.
When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.this@Stability(value=Stable) public CfnScalableTargetProps.Builder resourceId(String resourceId)
CfnScalableTargetProps.getResourceId()resourceId - The identifier of the resource associated with the scalable target. This parameter is required.
This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .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 .arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .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 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .this@Stability(value=Stable) public CfnScalableTargetProps.Builder roleArn(String roleArn)
CfnScalableTargetProps.getRoleArn()roleArn - Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required.
This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide .
To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide . Look for the ARN in the table at the bottom of the page.
this@Stability(value=Stable) public CfnScalableTargetProps.Builder scalableDimension(String scalableDimension)
CfnScalableTargetProps.getScalableDimension()scalableDimension - The scalable dimension associated with the scalable target. This parameter is required.
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.this@Stability(value=Stable) public CfnScalableTargetProps.Builder serviceNamespace(String serviceNamespace)
CfnScalableTargetProps.getServiceNamespace()serviceNamespace - The namespace of the AWS service that provides the resource, or a `custom-resource` . This parameter is required.this@Stability(value=Stable) public CfnScalableTargetProps.Builder scheduledActions(IResolvable scheduledActions)
CfnScalableTargetProps.getScheduledActions()scheduledActions - The scheduled actions for the scalable target. Duplicates aren't allowed.
For more information about using scheduled scaling, see Scheduled scaling in the Application Auto Scaling User Guide .this@Stability(value=Stable) public CfnScalableTargetProps.Builder scheduledActions(List<? extends Object> scheduledActions)
CfnScalableTargetProps.getScheduledActions()scheduledActions - The scheduled actions for the scalable target. Duplicates aren't allowed.
For more information about using scheduled scaling, see Scheduled scaling in the Application Auto Scaling User Guide .this@Stability(value=Stable) public CfnScalableTargetProps.Builder suspendedState(CfnScalableTarget.SuspendedStateProperty suspendedState)
CfnScalableTargetProps.getSuspendedState()suspendedState - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling.
Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
Suspension Outcomes
DynamicScalingInSuspended , while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.DynamicScalingOutSuspended , while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.ScheduledScalingSuspended , while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide .
this@Stability(value=Stable) public CfnScalableTargetProps.Builder suspendedState(IResolvable suspendedState)
CfnScalableTargetProps.getSuspendedState()suspendedState - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling.
Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
Suspension Outcomes
DynamicScalingInSuspended , while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.DynamicScalingOutSuspended , while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.ScheduledScalingSuspended , while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide .
this@Stability(value=Stable) public CfnScalableTargetProps build()
build in interface software.amazon.jsii.Builder<CfnScalableTargetProps>CfnScalableTargetPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.