class CfnServer (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.OpsWorksCM.CfnServer`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsopsworkscm#CfnServer`
Java	`software.amazon.awscdk.services.opsworkscm.CfnServer`
Python	`aws_cdk.aws_opsworkscm.CfnServer`
TypeScript	`aws-cdk-lib` » `aws_opsworkscm` » `CfnServer`

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::OpsWorksCM::Server resource creates an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise configuration management server.

For more information, see Create a Chef Automate Server in AWS CloudFormation or Create a Puppet Enterprise Master in AWS CloudFormation in the AWS OpsWorks User Guide , and CreateServer in the AWS OpsWorks CM API Reference .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opsworkscm as opsworkscm } from 'aws-cdk-lib';
const cfnServer = new opsworkscm.CfnServer(this, 'MyCfnServer', {
  instanceProfileArn: 'instanceProfileArn',
  instanceType: 'instanceType',
  serviceRoleArn: 'serviceRoleArn',

  // the properties below are optional
  associatePublicIpAddress: false,
  backupId: 'backupId',
  backupRetentionCount: 123,
  customCertificate: 'customCertificate',
  customDomain: 'customDomain',
  customPrivateKey: 'customPrivateKey',
  disableAutomatedBackup: false,
  engine: 'engine',
  engineAttributes: [{
    name: 'name',
    value: 'value',
  }],
  engineModel: 'engineModel',
  engineVersion: 'engineVersion',
  keyPair: 'keyPair',
  preferredBackupWindow: 'preferredBackupWindow',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  securityGroupIds: ['securityGroupIds'],
  serverName: 'serverName',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnServer(scope: Construct, id: string, props: CfnServerProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnServerProps — Resource properties.

Construct Props

Name	Type	Description
instanceProfileArn	`string`	The ARN of the instance profile that your Amazon EC2 instances use.
instanceType	`string`	The Amazon EC2 instance type to use.
serviceRoleArn	`string`	The service role that the AWS OpsWorks CM service backend uses to work with your account.
associatePublicIpAddress?	`boolean \|` `IResolvable`	Associate a public IP address with a server that you are launching.
backupId?	`string`	If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
backupRetentionCount?	`number`	The number of automated backups that you want to keep.
customCertificate?	`string`	Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for `CustomDomain` and `CustomPrivateKey` . The following are requirements for the `CustomCertificate` value:.
customDomain?	`string`	Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as `https://aws.my-company.com` . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated `Endpoint` value if the server is using a custom domain. If you specify a custom domain, you must also specify values for `CustomCertificate` and `CustomPrivateKey` .
customPrivateKey?	`string`	Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for `CustomDomain` and `CustomCertificate` .
disableAutomatedBackup?	`boolean \|` `IResolvable`	Enable or disable scheduled backups.
engine?	`string`	The configuration management engine to use.
engineAttributes?	`IResolvable` `\|` `IResolvable` `\|` `EngineAttributeProperty[]`	Optional engine attributes on a specified server.
engineModel?	`string`	The engine model of the server.
engineVersion?	`string`	The major release version of the engine that you want to use.
keyPair?	`string`	The Amazon EC2 key pair to set for the instance.
preferredBackupWindow?	`string`	The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.
preferredMaintenanceWindow?	`string`	The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
securityGroupIds?	`string[]`	A list of security group IDs to attach to the Amazon EC2 instance.
serverName?	`string`	The name of the server.
subnetIds?	`string[]`	The IDs of subnets in which to launch the server EC2 instance.
tags?	`CfnTag[]`	A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

instanceProfileArn

Type: string

The ARN of the instance profile that your Amazon EC2 instances use.

instanceType

Type: string

The Amazon EC2 instance type to use.

For example, m5.large .

serviceRoleArn

Type: string

The service role that the AWS OpsWorks CM service backend uses to work with your account.

Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.

associatePublicIpAddress?

Type: boolean | IResolvable (optional)

Associate a public IP address with a server that you are launching.

Valid values are true or false . The default value is true .

backupId?

Type: string (optional)

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

backupRetentionCount?

Type: number (optional)

The number of automated backups that you want to keep.

Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .

customCertificate?

Type: string (optional)

Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:.

You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
The certificate must match the value of CustomPrivateKey .

customDomain?

Type: string (optional)

Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey .

customPrivateKey?

Type: string (optional)

Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate .

disableAutomatedBackup?

Type: boolean | IResolvable (optional)

Enable or disable scheduled backups.

Valid values are true or false . The default value is true .

engine?

Type: string (optional)

The configuration management engine to use.

Valid values include ChefAutomate and Puppet .

engineAttributes?

Type: IResolvable | IResolvable | EngineAttributeProperty[] (optional)

Optional engine attributes on a specified server.

Attributes accepted in a Chef createServer request: - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline ( \n ) characters at the end of each line of the pivotal key value.

CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

engineModel?

Type: string (optional)

The engine model of the server.

Valid values in this release include Monolithic for Puppet and Single for Chef.

engineVersion?

Type: string (optional)

The major release version of the engine that you want to use.

For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .

keyPair?

Type: string (optional)

The Amazon EC2 key pair to set for the instance.

This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

preferredBackupWindow?

Type: string (optional)

The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.

Valid values must be specified in one of the following formats:

HH:MM for daily backups
DDD:HH:MM for weekly backups

MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

Example: 08:00 , which represents a daily start time of 08:00 UTC.

Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

preferredMaintenanceWindow?

Type: string (optional)

The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.

Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

securityGroupIds?

Type: string[] (optional)

A list of security group IDs to attach to the Amazon EC2 instance.

If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds .

If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

serverName?

Type: string (optional)

The name of the server.

The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.

subnetIds?

Type: string[] (optional)

The IDs of subnets in which to launch the server EC2 instance.

Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.

EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.

For more information about supported Amazon EC2 platforms, see Supported Platforms .

tags?

Type: CfnTag[] (optional)

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /

Properties

Name	Type	Description
attrArn	`string`	The Amazon Resource Name (ARN) of the server, such as `arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi` .
attrEndpoint	`string`	A DNS name that can be used to access the engine.
attrServerName	`string`	The name of the server.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
instanceProfileArn	`string`	The ARN of the instance profile that your Amazon EC2 instances use.
instanceType	`string`	The Amazon EC2 instance type to use.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
serviceRoleArn	`string`	The service role that the AWS OpsWorks CM service backend uses to work with your account.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
associatePublicIpAddress?	`boolean \|` `IResolvable`	Associate a public IP address with a server that you are launching.
backupId?	`string`	If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
backupRetentionCount?	`number`	The number of automated backups that you want to keep.
customCertificate?	`string`	Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for `CustomDomain` and `CustomPrivateKey` . The following are requirements for the `CustomCertificate` value:.
customDomain?	`string`	Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as `https://aws.my-company.com` . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated `Endpoint` value if the server is using a custom domain. If you specify a custom domain, you must also specify values for `CustomCertificate` and `CustomPrivateKey` .
customPrivateKey?	`string`	Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for `CustomDomain` and `CustomCertificate` .
disableAutomatedBackup?	`boolean \|` `IResolvable`	Enable or disable scheduled backups.
engine?	`string`	The configuration management engine to use.
engineAttributes?	`IResolvable` `\|` `IResolvable` `\|` `EngineAttributeProperty[]`	Optional engine attributes on a specified server.
engineModel?	`string`	The engine model of the server.
engineVersion?	`string`	The major release version of the engine that you want to use.
keyPair?	`string`	The Amazon EC2 key pair to set for the instance.
preferredBackupWindow?	`string`	The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.
preferredMaintenanceWindow?	`string`	The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
securityGroupIds?	`string[]`	A list of security group IDs to attach to the Amazon EC2 instance.
serverName?	`string`	The name of the server.
subnetIds?	`string[]`	The IDs of subnets in which to launch the server EC2 instance.
tagsRaw?	`CfnTag[]`	A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .

attrEndpoint

Type: string

A DNS name that can be used to access the engine.

Example: myserver-asdfghjkl.us-east-1.opsworks.io .

attrServerName

Type: string

The name of the server.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

instanceProfileArn

Type: string

The ARN of the instance profile that your Amazon EC2 instances use.

instanceType

Type: string

The Amazon EC2 instance type to use.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

serviceRoleArn

Type: string

The service role that the AWS OpsWorks CM service backend uses to work with your account.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

associatePublicIpAddress?

Type: boolean | IResolvable (optional)

Associate a public IP address with a server that you are launching.

backupId?

Type: string (optional)

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

backupRetentionCount?

Type: number (optional)

The number of automated backups that you want to keep.

customCertificate?

Type: string (optional)

customDomain?

Type: string (optional)

customPrivateKey?

Type: string (optional)

disableAutomatedBackup?

Type: boolean | IResolvable (optional)

Enable or disable scheduled backups.

engine?

Type: string (optional)

The configuration management engine to use.

engineAttributes?

Type: IResolvable | IResolvable | EngineAttributeProperty[] (optional)

Optional engine attributes on a specified server.

engineModel?

Type: string (optional)

The engine model of the server.

engineVersion?

Type: string (optional)

The major release version of the engine that you want to use.

keyPair?

Type: string (optional)

The Amazon EC2 key pair to set for the instance.

preferredBackupWindow?

Type: string (optional)

The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.

preferredMaintenanceWindow?

Type: string (optional)

The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.

securityGroupIds?

Type: string[] (optional)

A list of security group IDs to attach to the Amazon EC2 instance.

serverName?

Type: string (optional)

The name of the server.

subnetIds?

Type: string[] (optional)

The IDs of subnets in which to launch the server EC2 instance.

tagsRaw?

Type: CfnTag[] (optional)

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }