Skip to content

Latest commit

 

History

History
1366 lines (850 loc) · 65.7 KB

appautoscalingScheduledAction.md

File metadata and controls

1366 lines (850 loc) · 65.7 KB

aws_appautoscaling_scheduled_action

Refer to the Terraform Registory for docs: aws_appautoscaling_scheduled_action.

appautoscalingScheduledAction Submodule

Constructs

AppautoscalingScheduledAction

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action aws_appautoscaling_scheduled_action}.

Initializers 

import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

new appautoscalingScheduledAction.AppautoscalingScheduledAction(scope: Construct, id: string, config: AppautoscalingScheduledActionConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AppautoscalingScheduledActionConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
putScalableTargetAction No description.
resetEndTime No description.
resetId No description.
resetStartTime No description.
resetTimezone No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putScalableTargetAction 
public putScalableTargetAction(value: AppautoscalingScheduledActionScalableTargetAction): void
valueRequired
resetEndTime 
public resetEndTime(): void
resetId 
public resetId(): void
resetStartTime 
public resetStartTime(): void
resetTimezone 
public resetTimezone(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

appautoscalingScheduledAction.AppautoscalingScheduledAction.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

appautoscalingScheduledAction.AppautoscalingScheduledAction.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

appautoscalingScheduledAction.AppautoscalingScheduledAction.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
scalableTargetAction AppautoscalingScheduledActionScalableTargetActionOutputReference No description.
endTimeInput string No description.
idInput string No description.
nameInput string No description.
resourceIdInput string No description.
scalableDimensionInput string No description.
scalableTargetActionInput AppautoscalingScheduledActionScalableTargetAction No description.
scheduleInput string No description.
serviceNamespaceInput string No description.
startTimeInput string No description.
timezoneInput string No description.
endTime string No description.
id string No description.
name string No description.
resourceId string No description.
scalableDimension string No description.
schedule string No description.
serviceNamespace string No description.
startTime string No description.
timezone string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
scalableTargetActionRequired 
public readonly scalableTargetAction: AppautoscalingScheduledActionScalableTargetActionOutputReference;
endTimeInputOptional 
public readonly endTimeInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
resourceIdInputOptional 
public readonly resourceIdInput: string;
  • Type: string
scalableDimensionInputOptional 
public readonly scalableDimensionInput: string;
  • Type: string
scalableTargetActionInputOptional 
public readonly scalableTargetActionInput: AppautoscalingScheduledActionScalableTargetAction;
scheduleInputOptional 
public readonly scheduleInput: string;
  • Type: string
serviceNamespaceInputOptional 
public readonly serviceNamespaceInput: string;
  • Type: string
startTimeInputOptional 
public readonly startTimeInput: string;
  • Type: string
timezoneInputOptional 
public readonly timezoneInput: string;
  • Type: string
endTimeRequired 
public readonly endTime: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
resourceIdRequired 
public readonly resourceId: string;
  • Type: string
scalableDimensionRequired 
public readonly scalableDimension: string;
  • Type: string
scheduleRequired 
public readonly schedule: string;
  • Type: string
serviceNamespaceRequired 
public readonly serviceNamespace: string;
  • Type: string
startTimeRequired 
public readonly startTime: string;
  • Type: string
timezoneRequired 
public readonly timezone: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

AppautoscalingScheduledActionConfig

Initializer 

import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

const appautoscalingScheduledActionConfig: appautoscalingScheduledAction.AppautoscalingScheduledActionConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#name AppautoscalingScheduledAction#name}.
resourceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#resource_id AppautoscalingScheduledAction#resource_id}.
scalableDimension string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#scalable_dimension AppautoscalingScheduledAction#scalable_dimension}.
scalableTargetAction AppautoscalingScheduledActionScalableTargetAction scalable_target_action block.
schedule string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#schedule AppautoscalingScheduledAction#schedule}.
serviceNamespace string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#service_namespace AppautoscalingScheduledAction#service_namespace}.
endTime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#end_time AppautoscalingScheduledAction#end_time}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#id AppautoscalingScheduledAction#id}.
startTime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#start_time AppautoscalingScheduledAction#start_time}.
timezone string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#timezone AppautoscalingScheduledAction#timezone}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#name AppautoscalingScheduledAction#name}.

resourceIdRequired 
public readonly resourceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#resource_id AppautoscalingScheduledAction#resource_id}.

scalableDimensionRequired 
public readonly scalableDimension: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#scalable_dimension AppautoscalingScheduledAction#scalable_dimension}.

scalableTargetActionRequired 
public readonly scalableTargetAction: AppautoscalingScheduledActionScalableTargetAction;

scalable_target_action block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#scalable_target_action AppautoscalingScheduledAction#scalable_target_action}

scheduleRequired 
public readonly schedule: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#schedule AppautoscalingScheduledAction#schedule}.

serviceNamespaceRequired 
public readonly serviceNamespace: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#service_namespace AppautoscalingScheduledAction#service_namespace}.

endTimeOptional 
public readonly endTime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#end_time AppautoscalingScheduledAction#end_time}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#id AppautoscalingScheduledAction#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

startTimeOptional 
public readonly startTime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#start_time AppautoscalingScheduledAction#start_time}.

timezoneOptional 
public readonly timezone: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#timezone AppautoscalingScheduledAction#timezone}.

AppautoscalingScheduledActionScalableTargetAction

Initializer 

import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

const appautoscalingScheduledActionScalableTargetAction: appautoscalingScheduledAction.AppautoscalingScheduledActionScalableTargetAction = { ... }

Properties

Name Type Description
maxCapacity string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#max_capacity AppautoscalingScheduledAction#max_capacity}.
minCapacity string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#min_capacity AppautoscalingScheduledAction#min_capacity}.
maxCapacityOptional 
public readonly maxCapacity: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#max_capacity AppautoscalingScheduledAction#max_capacity}.

minCapacityOptional 
public readonly minCapacity: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appautoscaling_scheduled_action#min_capacity AppautoscalingScheduledAction#min_capacity}.

Classes

AppautoscalingScheduledActionScalableTargetActionOutputReference

Initializers 

import { appautoscalingScheduledAction } from '@cdktf/aws-cdk'

new appautoscalingScheduledAction.AppautoscalingScheduledActionScalableTargetActionOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetMaxCapacity No description.
resetMinCapacity No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetMaxCapacity 
public resetMaxCapacity(): void
resetMinCapacity 
public resetMinCapacity(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
maxCapacityInput string No description.
minCapacityInput string No description.
maxCapacity string No description.
minCapacity string No description.
internalValue AppautoscalingScheduledActionScalableTargetAction No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
maxCapacityInputOptional 
public readonly maxCapacityInput: string;
  • Type: string
minCapacityInputOptional 
public readonly minCapacityInput: string;
  • Type: string
maxCapacityRequired 
public readonly maxCapacity: string;
  • Type: string
minCapacityRequired 
public readonly minCapacity: string;
  • Type: string
internalValueOptional 
public readonly internalValue: AppautoscalingScheduledActionScalableTargetAction;