Documentation
¶
Index ¶
- type Policy
- func (r *Policy) AdjustmentType() *pulumi.StringOutput
- func (r *Policy) Alarms() *pulumi.ArrayOutput
- func (r *Policy) Arn() *pulumi.StringOutput
- func (r *Policy) Cooldown() *pulumi.IntOutput
- func (r *Policy) ID() *pulumi.IDOutput
- func (r *Policy) MetricAggregationType() *pulumi.StringOutput
- func (r *Policy) MinAdjustmentMagnitude() *pulumi.IntOutput
- func (r *Policy) Name() *pulumi.StringOutput
- func (r *Policy) PolicyType() *pulumi.StringOutput
- func (r *Policy) ResourceId() *pulumi.StringOutput
- func (r *Policy) ScalableDimension() *pulumi.StringOutput
- func (r *Policy) ServiceNamespace() *pulumi.StringOutput
- func (r *Policy) StepAdjustments() *pulumi.ArrayOutput
- func (r *Policy) StepScalingPolicyConfigurations() *pulumi.ArrayOutput
- func (r *Policy) TargetTrackingScalingPolicyConfiguration() *pulumi.Output
- func (r *Policy) URN() *pulumi.URNOutput
- type PolicyArgs
- type PolicyState
- type ScheduledAction
- func (r *ScheduledAction) Arn() *pulumi.StringOutput
- func (r *ScheduledAction) EndTime() *pulumi.StringOutput
- func (r *ScheduledAction) ID() *pulumi.IDOutput
- func (r *ScheduledAction) Name() *pulumi.StringOutput
- func (r *ScheduledAction) ResourceId() *pulumi.StringOutput
- func (r *ScheduledAction) ScalableDimension() *pulumi.StringOutput
- func (r *ScheduledAction) ScalableTargetAction() *pulumi.Output
- func (r *ScheduledAction) Schedule() *pulumi.StringOutput
- func (r *ScheduledAction) ServiceNamespace() *pulumi.StringOutput
- func (r *ScheduledAction) StartTime() *pulumi.StringOutput
- func (r *ScheduledAction) URN() *pulumi.URNOutput
- type ScheduledActionArgs
- type ScheduledActionState
- type Target
- func (r *Target) ID() *pulumi.IDOutput
- func (r *Target) MaxCapacity() *pulumi.IntOutput
- func (r *Target) MinCapacity() *pulumi.IntOutput
- func (r *Target) ResourceId() *pulumi.StringOutput
- func (r *Target) RoleArn() *pulumi.StringOutput
- func (r *Target) ScalableDimension() *pulumi.StringOutput
- func (r *Target) ServiceNamespace() *pulumi.StringOutput
- func (r *Target) URN() *pulumi.URNOutput
- type TargetArgs
- type TargetState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Policy ¶
type Policy struct {
// contains filtered or unexported fields
}
Provides an Application AutoScaling Policy resource.
## Nested fields
### `target_tracking_scaling_policy_configuration`
* `target_value` - (Required) The target value for the metric. * `disable_scale_in` - (Optional) Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is `false`. * `scale_in_cooldown` - (Optional) The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. * `scale_out_cooldown` - (Optional) The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. * `customized_metric_specification` - (Optional) Reserved for future use. See supported fields below. * `predefined_metric_specification` - (Optional) A predefined metric. See supported fields below.
### `customized_metric_specification`
* `dimensions` - (Optional) The dimensions of the metric. * `metric_name` - (Required) The name of the metric. * `namespace` - (Required) The namespace of the metric. * `statistic` - (Required) The statistic of the metric. * `unit` - (Optional) The unit of the metric.
### `predefined_metric_specification`
* `predefined_metric_type` - (Required) The metric type. * `resource_label` - (Optional) Reserved for future use.
func GetPolicy ¶
func GetPolicy(ctx *pulumi.Context, name string, id pulumi.ID, state *PolicyState, opts ...pulumi.ResourceOpt) (*Policy, error)
GetPolicy gets an existing Policy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewPolicy ¶
func NewPolicy(ctx *pulumi.Context, name string, args *PolicyArgs, opts ...pulumi.ResourceOpt) (*Policy, error)
NewPolicy registers a new resource with the given unique name, arguments, and options.
func (*Policy) AdjustmentType ¶
func (r *Policy) AdjustmentType() *pulumi.StringOutput
The scaling policy's adjustment type.
func (*Policy) Alarms ¶
func (r *Policy) Alarms() *pulumi.ArrayOutput
func (*Policy) Arn ¶
func (r *Policy) Arn() *pulumi.StringOutput
The ARN assigned by AWS to the scaling policy.
func (*Policy) MetricAggregationType ¶
func (r *Policy) MetricAggregationType() *pulumi.StringOutput
func (*Policy) MinAdjustmentMagnitude ¶
func (*Policy) PolicyType ¶
func (r *Policy) PolicyType() *pulumi.StringOutput
For DynamoDB, only `TargetTrackingScaling` is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both `StepScaling` and `TargetTrackingScaling` are supported. For any other service, only `StepScaling` is supported. Defaults to `StepScaling`.
func (*Policy) ResourceId ¶
func (r *Policy) ResourceId() *pulumi.StringOutput
The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters)
func (*Policy) ScalableDimension ¶
func (r *Policy) ScalableDimension() *pulumi.StringOutput
The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters)
func (*Policy) ServiceNamespace ¶
func (r *Policy) ServiceNamespace() *pulumi.StringOutput
The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters)
func (*Policy) StepAdjustments ¶
func (r *Policy) StepAdjustments() *pulumi.ArrayOutput
func (*Policy) StepScalingPolicyConfigurations ¶
func (r *Policy) StepScalingPolicyConfigurations() *pulumi.ArrayOutput
Step scaling policy configuration, requires `policy_type = "StepScaling"` (default). See supported fields below.
func (*Policy) TargetTrackingScalingPolicyConfiguration ¶
A target tracking policy, requires `policy_type = "TargetTrackingScaling"`. See supported fields below.
type PolicyArgs ¶
type PolicyArgs struct { // The scaling policy's adjustment type. AdjustmentType interface{} Alarms interface{} Cooldown interface{} MetricAggregationType interface{} MinAdjustmentMagnitude interface{} // The name of the policy. Name interface{} // For DynamoDB, only `TargetTrackingScaling` is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both `StepScaling` and `TargetTrackingScaling` are supported. For any other service, only `StepScaling` is supported. Defaults to `StepScaling`. PolicyType interface{} // The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ResourceId interface{} // The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ScalableDimension interface{} // The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ServiceNamespace interface{} StepAdjustments interface{} // Step scaling policy configuration, requires `policy_type = "StepScaling"` (default). See supported fields below. StepScalingPolicyConfigurations interface{} // A target tracking policy, requires `policy_type = "TargetTrackingScaling"`. See supported fields below. TargetTrackingScalingPolicyConfiguration interface{} }
The set of arguments for constructing a Policy resource.
type PolicyState ¶
type PolicyState struct { // The scaling policy's adjustment type. AdjustmentType interface{} Alarms interface{} // The ARN assigned by AWS to the scaling policy. Arn interface{} Cooldown interface{} MetricAggregationType interface{} MinAdjustmentMagnitude interface{} // The name of the policy. Name interface{} // For DynamoDB, only `TargetTrackingScaling` is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both `StepScaling` and `TargetTrackingScaling` are supported. For any other service, only `StepScaling` is supported. Defaults to `StepScaling`. PolicyType interface{} // The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ResourceId interface{} // The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ScalableDimension interface{} // The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ServiceNamespace interface{} StepAdjustments interface{} // Step scaling policy configuration, requires `policy_type = "StepScaling"` (default). See supported fields below. StepScalingPolicyConfigurations interface{} // A target tracking policy, requires `policy_type = "TargetTrackingScaling"`. See supported fields below. TargetTrackingScalingPolicyConfiguration interface{} }
Input properties used for looking up and filtering Policy resources.
type ScheduledAction ¶
type ScheduledAction struct {
// contains filtered or unexported fields
}
Provides an Application AutoScaling ScheduledAction resource.
func GetScheduledAction ¶
func GetScheduledAction(ctx *pulumi.Context, name string, id pulumi.ID, state *ScheduledActionState, opts ...pulumi.ResourceOpt) (*ScheduledAction, error)
GetScheduledAction gets an existing ScheduledAction resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewScheduledAction ¶
func NewScheduledAction(ctx *pulumi.Context, name string, args *ScheduledActionArgs, opts ...pulumi.ResourceOpt) (*ScheduledAction, error)
NewScheduledAction registers a new resource with the given unique name, arguments, and options.
func (*ScheduledAction) Arn ¶
func (r *ScheduledAction) Arn() *pulumi.StringOutput
The Amazon Resource Name (ARN) of the scheduled action.
func (*ScheduledAction) EndTime ¶
func (r *ScheduledAction) EndTime() *pulumi.StringOutput
The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z
func (*ScheduledAction) ID ¶
func (r *ScheduledAction) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*ScheduledAction) Name ¶
func (r *ScheduledAction) Name() *pulumi.StringOutput
The name of the scheduled action.
func (*ScheduledAction) ResourceId ¶
func (r *ScheduledAction) ResourceId() *pulumi.StringOutput
The identifier of the resource associated with the scheduled action. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ResourceId)
func (*ScheduledAction) ScalableDimension ¶
func (r *ScheduledAction) ScalableDimension() *pulumi.StringOutput
The scalable dimension. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ScalableDimension) Example: ecs:service:DesiredCount
func (*ScheduledAction) ScalableTargetAction ¶
func (r *ScheduledAction) ScalableTargetAction() *pulumi.Output
The new minimum and maximum capacity. You can set both values or just one. See below
func (*ScheduledAction) Schedule ¶
func (r *ScheduledAction) Schedule() *pulumi.StringOutput
The schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). In UTC. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-Schedule)
func (*ScheduledAction) ServiceNamespace ¶
func (r *ScheduledAction) ServiceNamespace() *pulumi.StringOutput
The namespace of the AWS service. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ServiceNamespace) Example: ecs
func (*ScheduledAction) StartTime ¶
func (r *ScheduledAction) StartTime() *pulumi.StringOutput
The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z
func (*ScheduledAction) URN ¶
func (r *ScheduledAction) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type ScheduledActionArgs ¶
type ScheduledActionArgs struct { // The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z EndTime interface{} // The name of the scheduled action. Name interface{} // The identifier of the resource associated with the scheduled action. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ResourceId) ResourceId interface{} // The scalable dimension. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ScalableDimension) Example: ecs:service:DesiredCount ScalableDimension interface{} // The new minimum and maximum capacity. You can set both values or just one. See below ScalableTargetAction interface{} // The schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). In UTC. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-Schedule) Schedule interface{} // The namespace of the AWS service. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ServiceNamespace) Example: ecs ServiceNamespace interface{} // The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z StartTime interface{} }
The set of arguments for constructing a ScheduledAction resource.
type ScheduledActionState ¶
type ScheduledActionState struct { // The Amazon Resource Name (ARN) of the scheduled action. Arn interface{} // The date and time for the scheduled action to end. Specify the following format: 2006-01-02T15:04:05Z EndTime interface{} // The name of the scheduled action. Name interface{} // The identifier of the resource associated with the scheduled action. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ResourceId) ResourceId interface{} // The scalable dimension. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ScalableDimension) Example: ecs:service:DesiredCount ScalableDimension interface{} // The new minimum and maximum capacity. You can set both values or just one. See below ScalableTargetAction interface{} // The schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). In UTC. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-Schedule) Schedule interface{} // The namespace of the AWS service. Documentation can be found in the parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScheduledAction.html#ApplicationAutoScaling-PutScheduledAction-request-ServiceNamespace) Example: ecs ServiceNamespace interface{} // The date and time for the scheduled action to start. Specify the following format: 2006-01-02T15:04:05Z StartTime interface{} }
Input properties used for looking up and filtering ScheduledAction resources.
type Target ¶
type Target struct {
// contains filtered or unexported fields
}
Provides an Application AutoScaling ScalableTarget resource. To manage policies which get attached to the target, see the [`aws_appautoscaling_policy` resource](https://www.terraform.io/docs/providers/aws/r/appautoscaling_policy.html).
func GetTarget ¶
func GetTarget(ctx *pulumi.Context, name string, id pulumi.ID, state *TargetState, opts ...pulumi.ResourceOpt) (*Target, error)
GetTarget gets an existing Target resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewTarget ¶
func NewTarget(ctx *pulumi.Context, name string, args *TargetArgs, opts ...pulumi.ResourceOpt) (*Target, error)
NewTarget registers a new resource with the given unique name, arguments, and options.
func (*Target) MaxCapacity ¶
The max capacity of the scalable target.
func (*Target) MinCapacity ¶
The min capacity of the scalable target.
func (*Target) ResourceId ¶
func (r *Target) ResourceId() *pulumi.StringOutput
The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters)
func (*Target) RoleArn ¶
func (r *Target) RoleArn() *pulumi.StringOutput
The ARN of the IAM role that allows Application AutoScaling to modify your scalable target on your behalf.
func (*Target) ScalableDimension ¶
func (r *Target) ScalableDimension() *pulumi.StringOutput
The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters)
func (*Target) ServiceNamespace ¶
func (r *Target) ServiceNamespace() *pulumi.StringOutput
The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters)
type TargetArgs ¶
type TargetArgs struct { // The max capacity of the scalable target. MaxCapacity interface{} // The min capacity of the scalable target. MinCapacity interface{} // The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ResourceId interface{} // The ARN of the IAM role that allows Application // AutoScaling to modify your scalable target on your behalf. RoleArn interface{} // The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ScalableDimension interface{} // The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ServiceNamespace interface{} }
The set of arguments for constructing a Target resource.
type TargetState ¶
type TargetState struct { // The max capacity of the scalable target. MaxCapacity interface{} // The min capacity of the scalable target. MinCapacity interface{} // The resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ResourceId interface{} // The ARN of the IAM role that allows Application // AutoScaling to modify your scalable target on your behalf. RoleArn interface{} // The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ScalableDimension interface{} // The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) ServiceNamespace interface{} }
Input properties used for looking up and filtering Target resources.