Skip to content

Latest commit

 

History

History
2271 lines (1400 loc) · 95.4 KB

ssmAssociation.md

File metadata and controls

2271 lines (1400 loc) · 95.4 KB

ssmAssociation Submodule

Constructs

SsmAssociation

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

Initializers 

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

new ssmAssociation.SsmAssociation(scope: Construct, id: string, config: SsmAssociationConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config SsmAssociationConfig 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.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putOutputLocation No description.
putTargets No description.
resetApplyOnlyAtCronInterval No description.
resetAssociationName No description.
resetAutomationTargetParameterName No description.
resetComplianceSeverity No description.
resetDocumentVersion No description.
resetId No description.
resetInstanceId No description.
resetMaxConcurrency No description.
resetMaxErrors No description.
resetOutputLocation No description.
resetParameters No description.
resetScheduleExpression No description.
resetTargets 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.

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

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

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
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putOutputLocation 
public putOutputLocation(value: SsmAssociationOutputLocation): void
valueRequired
putTargets 
public putTargets(value: IResolvable | SsmAssociationTargets[]): void
valueRequired
resetApplyOnlyAtCronInterval 
public resetApplyOnlyAtCronInterval(): void
resetAssociationName 
public resetAssociationName(): void
resetAutomationTargetParameterName 
public resetAutomationTargetParameterName(): void
resetComplianceSeverity 
public resetComplianceSeverity(): void
resetDocumentVersion 
public resetDocumentVersion(): void
resetId 
public resetId(): void
resetInstanceId 
public resetInstanceId(): void
resetMaxConcurrency 
public resetMaxConcurrency(): void
resetMaxErrors 
public resetMaxErrors(): void
resetOutputLocation 
public resetOutputLocation(): void
resetParameters 
public resetParameters(): void
resetScheduleExpression 
public resetScheduleExpression(): void
resetTargets 
public resetTargets(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a SsmAssociation resource upon running "cdktf plan ".
isConstruct 
import { ssmAssociation } from '@cdktf/aws-cdk'

ssmAssociation.SsmAssociation.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

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

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

ssmAssociation.SsmAssociation.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { ssmAssociation } from '@cdktf/aws-cdk'

ssmAssociation.SsmAssociation.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a SsmAssociation resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the SsmAssociation to import.

importFromIdRequired
  • Type: string

The id of the existing SsmAssociation that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the SsmAssociation to import is found.

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.
associationId string No description.
outputLocation SsmAssociationOutputLocationOutputReference No description.
targets SsmAssociationTargetsList No description.
applyOnlyAtCronIntervalInput boolean | cdktf.IResolvable No description.
associationNameInput string No description.
automationTargetParameterNameInput string No description.
complianceSeverityInput string No description.
documentVersionInput string No description.
idInput string No description.
instanceIdInput string No description.
maxConcurrencyInput string No description.
maxErrorsInput string No description.
nameInput string No description.
outputLocationInput SsmAssociationOutputLocation No description.
parametersInput {[ key: string ]: string} No description.
scheduleExpressionInput string No description.
targetsInput cdktf.IResolvable | SsmAssociationTargets[] No description.
applyOnlyAtCronInterval boolean | cdktf.IResolvable No description.
associationName string No description.
automationTargetParameterName string No description.
complianceSeverity string No description.
documentVersion string No description.
id string No description.
instanceId string No description.
maxConcurrency string No description.
maxErrors string No description.
name string No description.
parameters {[ key: string ]: string} No description.
scheduleExpression 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[]
associationIdRequired 
public readonly associationId: string;
  • Type: string
outputLocationRequired 
public readonly outputLocation: SsmAssociationOutputLocationOutputReference;
targetsRequired 
public readonly targets: SsmAssociationTargetsList;
applyOnlyAtCronIntervalInputOptional 
public readonly applyOnlyAtCronIntervalInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
associationNameInputOptional 
public readonly associationNameInput: string;
  • Type: string
automationTargetParameterNameInputOptional 
public readonly automationTargetParameterNameInput: string;
  • Type: string
complianceSeverityInputOptional 
public readonly complianceSeverityInput: string;
  • Type: string
documentVersionInputOptional 
public readonly documentVersionInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
instanceIdInputOptional 
public readonly instanceIdInput: string;
  • Type: string
maxConcurrencyInputOptional 
public readonly maxConcurrencyInput: string;
  • Type: string
maxErrorsInputOptional 
public readonly maxErrorsInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
outputLocationInputOptional 
public readonly outputLocationInput: SsmAssociationOutputLocation;
parametersInputOptional 
public readonly parametersInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
scheduleExpressionInputOptional 
public readonly scheduleExpressionInput: string;
  • Type: string
targetsInputOptional 
public readonly targetsInput: IResolvable | SsmAssociationTargets[];
applyOnlyAtCronIntervalRequired 
public readonly applyOnlyAtCronInterval: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
associationNameRequired 
public readonly associationName: string;
  • Type: string
automationTargetParameterNameRequired 
public readonly automationTargetParameterName: string;
  • Type: string
complianceSeverityRequired 
public readonly complianceSeverity: string;
  • Type: string
documentVersionRequired 
public readonly documentVersion: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
instanceIdRequired 
public readonly instanceId: string;
  • Type: string
maxConcurrencyRequired 
public readonly maxConcurrency: string;
  • Type: string
maxErrorsRequired 
public readonly maxErrors: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
parametersRequired 
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
scheduleExpressionRequired 
public readonly scheduleExpression: string;
  • Type: string

Constants

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

Structs

SsmAssociationConfig

Initializer 

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

const ssmAssociationConfig: ssmAssociation.SsmAssociationConfig = { ... }

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/ssm_association#name SsmAssociation#name}.
applyOnlyAtCronInterval boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#apply_only_at_cron_interval SsmAssociation#apply_only_at_cron_interval}.
associationName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#association_name SsmAssociation#association_name}.
automationTargetParameterName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#automation_target_parameter_name SsmAssociation#automation_target_parameter_name}.
complianceSeverity string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#compliance_severity SsmAssociation#compliance_severity}.
documentVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#document_version SsmAssociation#document_version}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#id SsmAssociation#id}.
instanceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#instance_id SsmAssociation#instance_id}.
maxConcurrency string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#max_concurrency SsmAssociation#max_concurrency}.
maxErrors string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#max_errors SsmAssociation#max_errors}.
outputLocation SsmAssociationOutputLocation output_location block.
parameters {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#parameters SsmAssociation#parameters}.
scheduleExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#schedule_expression SsmAssociation#schedule_expression}.
targets cdktf.IResolvable | SsmAssociationTargets[] targets block.
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/ssm_association#name SsmAssociation#name}.

applyOnlyAtCronIntervalOptional 
public readonly applyOnlyAtCronInterval: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#apply_only_at_cron_interval SsmAssociation#apply_only_at_cron_interval}.

associationNameOptional 
public readonly associationName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#association_name SsmAssociation#association_name}.

automationTargetParameterNameOptional 
public readonly automationTargetParameterName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#automation_target_parameter_name SsmAssociation#automation_target_parameter_name}.

complianceSeverityOptional 
public readonly complianceSeverity: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#compliance_severity SsmAssociation#compliance_severity}.

documentVersionOptional 
public readonly documentVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#document_version SsmAssociation#document_version}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#id SsmAssociation#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.

instanceIdOptional 
public readonly instanceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#instance_id SsmAssociation#instance_id}.

maxConcurrencyOptional 
public readonly maxConcurrency: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#max_concurrency SsmAssociation#max_concurrency}.

maxErrorsOptional 
public readonly maxErrors: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#max_errors SsmAssociation#max_errors}.

outputLocationOptional 
public readonly outputLocation: SsmAssociationOutputLocation;

output_location block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#output_location SsmAssociation#output_location}

parametersOptional 
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#parameters SsmAssociation#parameters}.

scheduleExpressionOptional 
public readonly scheduleExpression: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#schedule_expression SsmAssociation#schedule_expression}.

targetsOptional 
public readonly targets: IResolvable | SsmAssociationTargets[];

targets block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#targets SsmAssociation#targets}

SsmAssociationOutputLocation

Initializer 

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

const ssmAssociationOutputLocation: ssmAssociation.SsmAssociationOutputLocation = { ... }

Properties

Name Type Description
s3BucketName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#s3_bucket_name SsmAssociation#s3_bucket_name}.
s3KeyPrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#s3_key_prefix SsmAssociation#s3_key_prefix}.
s3Region string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#s3_region SsmAssociation#s3_region}.
s3BucketNameRequired 
public readonly s3BucketName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#s3_bucket_name SsmAssociation#s3_bucket_name}.

s3KeyPrefixOptional 
public readonly s3KeyPrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#s3_key_prefix SsmAssociation#s3_key_prefix}.

s3RegionOptional 
public readonly s3Region: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#s3_region SsmAssociation#s3_region}.

SsmAssociationTargets

Initializer 

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

const ssmAssociationTargets: ssmAssociation.SsmAssociationTargets = { ... }

Properties

Name Type Description
key string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#key SsmAssociation#key}.
values string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#values SsmAssociation#values}.
keyRequired 
public readonly key: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#key SsmAssociation#key}.

valuesRequired 
public readonly values: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ssm_association#values SsmAssociation#values}.

Classes

SsmAssociationOutputLocationOutputReference

Initializers 

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

new ssmAssociation.SsmAssociationOutputLocationOutputReference(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.
resetS3KeyPrefix No description.
resetS3Region 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.

resetS3KeyPrefix 
public resetS3KeyPrefix(): void
resetS3Region 
public resetS3Region(): 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.
s3BucketNameInput string No description.
s3KeyPrefixInput string No description.
s3RegionInput string No description.
s3BucketName string No description.
s3KeyPrefix string No description.
s3Region string No description.
internalValue SsmAssociationOutputLocation 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
s3BucketNameInputOptional 
public readonly s3BucketNameInput: string;
  • Type: string
s3KeyPrefixInputOptional 
public readonly s3KeyPrefixInput: string;
  • Type: string
s3RegionInputOptional 
public readonly s3RegionInput: string;
  • Type: string
s3BucketNameRequired 
public readonly s3BucketName: string;
  • Type: string
s3KeyPrefixRequired 
public readonly s3KeyPrefix: string;
  • Type: string
s3RegionRequired 
public readonly s3Region: string;
  • Type: string
internalValueOptional 
public readonly internalValue: SsmAssociationOutputLocation;

SsmAssociationTargetsList

Initializers 

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

new ssmAssociation.SsmAssociationTargetsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): 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.

get 
public get(index: number): SsmAssociationTargetsOutputReference
indexRequired
  • Type: number

the index of the item to return.

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.
internalValue cdktf.IResolvable | SsmAssociationTargets[] 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
internalValueOptional 
public readonly internalValue: IResolvable | SsmAssociationTargets[];

SsmAssociationTargetsOutputReference

Initializers 

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

new ssmAssociation.SsmAssociationTargetsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.
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.

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.
keyInput string No description.
valuesInput string[] No description.
key string No description.
values string[] No description.
internalValue cdktf.IResolvable | SsmAssociationTargets 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
keyInputOptional 
public readonly keyInput: string;
  • Type: string
valuesInputOptional 
public readonly valuesInput: string[];
  • Type: string[]
keyRequired 
public readonly key: string;
  • Type: string
valuesRequired 
public readonly values: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: IResolvable | SsmAssociationTargets;