1.204.0

class CfnFleet (construct)

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnFleet
Javasoftware.amazon.awscdk.services.gamelift.CfnFleet
Pythonaws_cdk.aws_gamelift.CfnFleet
TypeScript @aws-cdk/aws-gamelift » CfnFleet

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::GameLift::Fleet.

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers. A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift from '@aws-cdk/aws-gamelift';
const cfnFleet = new gamelift.CfnFleet(this, 'MyCfnFleet', {
  name: 'name',

  // the properties below are optional
  anywhereConfiguration: {
    cost: 'cost',
  },
  buildId: 'buildId',
  certificateConfiguration: {
    certificateType: 'certificateType',
  },
  computeType: 'computeType',
  description: 'description',
  desiredEc2Instances: 123,
  ec2InboundPermissions: [{
    fromPort: 123,
    ipRange: 'ipRange',
    protocol: 'protocol',
    toPort: 123,
  }],
  ec2InstanceType: 'ec2InstanceType',
  fleetType: 'fleetType',
  instanceRoleArn: 'instanceRoleArn',
  locations: [{
    location: 'location',

    // the properties below are optional
    locationCapacity: {
      desiredEc2Instances: 123,
      maxSize: 123,
      minSize: 123,
    },
  }],
  maxSize: 123,
  metricGroups: ['metricGroups'],
  minSize: 123,
  newGameSessionProtectionPolicy: 'newGameSessionProtectionPolicy',
  peerVpcAwsAccountId: 'peerVpcAwsAccountId',
  peerVpcId: 'peerVpcId',
  resourceCreationLimitPolicy: {
    newGameSessionsPerCreator: 123,
    policyPeriodInMinutes: 123,
  },
  runtimeConfiguration: {
    gameSessionActivationTimeoutSeconds: 123,
    maxConcurrentGameSessionActivations: 123,
    serverProcesses: [{
      concurrentExecutions: 123,
      launchPath: 'launchPath',

      // the properties below are optional
      parameters: 'parameters',
    }],
  },
  scriptId: 'scriptId',
});

Initializer

new CfnFleet(scope: Construct, id: string, props: CfnFleetProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnFleetProps — - resource properties.

Create a new AWS::GameLift::Fleet.

Construct Props

NameTypeDescription
namestringA descriptive label that is associated with a fleet.
anywhereConfiguration?IResolvable | AnywhereConfigurationPropertyAWS::GameLift::Fleet.AnywhereConfiguration.
buildId?stringA unique identifier for a build to be deployed on the new fleet.
certificateConfiguration?IResolvable | CertificateConfigurationPropertyPrompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
computeType?stringThe type of compute resource used to host your game servers.
description?stringA description for the fleet.
desiredEc2Instances?numberThe number of EC2 instances that you want this fleet to host.
ec2InboundPermissions?IResolvable | IResolvable | IpPermissionProperty[]The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
ec2InstanceType?stringThe Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.
fleetType?stringIndicates whether to use On-Demand or Spot instances for this fleet.
instanceRoleArn?stringA unique identifier for an IAM role that manages access to your AWS services.
locations?IResolvable | IResolvable | LocationConfigurationProperty[]A set of remote locations to deploy additional instances to and manage as part of the fleet.
maxSize?numberThe maximum number of instances that are allowed in the specified fleet location.
metricGroups?string[]The name of an AWS CloudWatch metric group to add this fleet to.
minSize?numberThe minimum number of instances that are allowed in the specified fleet location.
newGameSessionProtectionPolicy?stringThe status of termination protection for active game sessions on the fleet.
peerVpcAwsAccountId?stringUsed when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
peerVpcId?stringA unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
resourceCreationLimitPolicy?IResolvable | ResourceCreationLimitPolicyPropertyA policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
runtimeConfiguration?IResolvable | RuntimeConfigurationPropertyInstructions for how to launch and maintain server processes on instances in the fleet.
scriptId?stringThe unique identifier for a Realtime configuration script to be deployed on fleet instances.

name

Type: string

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

anywhereConfiguration?

Type: IResolvable | AnywhereConfigurationProperty (optional)

AWS::GameLift::Fleet.AnywhereConfiguration.

buildId?

Type: string (optional)

A unique identifier for a build to be deployed on the new fleet.

If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

certificateConfiguration?

Type: IResolvable | CertificateConfigurationProperty (optional)

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.

Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

computeType?

Type: string (optional)

The type of compute resource used to host your game servers.

You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

description?

Type: string (optional)

A description for the fleet.

desiredEc2Instances?

Type: number (optional)

The number of EC2 instances that you want this fleet to host.

When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

ec2InboundPermissions?

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

The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

ec2InstanceType?

Type: string (optional)

The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.

Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

fleetType?

Type: string (optional)

Indicates whether to use On-Demand or Spot instances for this fleet.

By default, this property is set to ON_DEMAND . Learn more about when to use On-Demand versus Spot Instances . This property cannot be changed after the fleet is created.

instanceRoleArn?

Type: string (optional)

A unique identifier for an IAM role that manages access to your AWS services.

With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This property cannot be changed after the fleet is created.

locations?

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

A set of remote locations to deploy additional instances to and manage as part of the fleet.

This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2 . To create a fleet with instances in the home Region only, don't use this parameter.

To use this parameter, Amazon GameLift requires you to use your home location in the request.

maxSize?

Type: number (optional)

The maximum number of instances that are allowed in the specified fleet location.

If this parameter is not set, the default is 1.

metricGroups?

Type: string[] (optional)

The name of an AWS CloudWatch metric group to add this fleet to.

A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

minSize?

Type: number (optional)

The minimum number of instances that are allowed in the specified fleet location.

If this parameter is not set, the default is 0.

newGameSessionProtectionPolicy?

Type: string (optional)

The status of termination protection for active game sessions on the fleet.

By default, this property is set to NoProtection .

  • NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
  • FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

peerVpcAwsAccountId?

Type: string (optional)

Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

You can find your account ID in the AWS Management Console under account settings.

peerVpcId?

Type: string (optional)

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.

The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .

resourceCreationLimitPolicy?

Type: IResolvable | ResourceCreationLimitPolicyProperty (optional)

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

runtimeConfiguration?

Type: IResolvable | RuntimeConfigurationProperty (optional)

Instructions for how to launch and maintain server processes on instances in the fleet.

The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

scriptId?

Type: string (optional)

The unique identifier for a Realtime configuration script to be deployed on fleet instances.

You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.

You can't use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.

Properties

NameTypeDescription
attrFleetIdstringA unique identifier for the fleet.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringA descriptive label that is associated with a fleet.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
anywhereConfiguration?IResolvable | AnywhereConfigurationPropertyAWS::GameLift::Fleet.AnywhereConfiguration.
buildId?stringA unique identifier for a build to be deployed on the new fleet.
certificateConfiguration?IResolvable | CertificateConfigurationPropertyPrompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
computeType?stringThe type of compute resource used to host your game servers.
description?stringA description for the fleet.
desiredEc2Instances?numberThe number of EC2 instances that you want this fleet to host.
ec2InboundPermissions?IResolvable | IResolvable | IpPermissionProperty[]The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
ec2InstanceType?stringThe Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.
fleetType?stringIndicates whether to use On-Demand or Spot instances for this fleet.
instanceRoleArn?stringA unique identifier for an IAM role that manages access to your AWS services.
locations?IResolvable | IResolvable | LocationConfigurationProperty[]A set of remote locations to deploy additional instances to and manage as part of the fleet.
maxSize?numberThe maximum number of instances that are allowed in the specified fleet location.
metricGroups?string[]The name of an AWS CloudWatch metric group to add this fleet to.
minSize?numberThe minimum number of instances that are allowed in the specified fleet location.
newGameSessionProtectionPolicy?stringThe status of termination protection for active game sessions on the fleet.
peerVpcAwsAccountId?stringUsed when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
peerVpcId?stringA unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
resourceCreationLimitPolicy?IResolvable | ResourceCreationLimitPolicyPropertyA policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
runtimeConfiguration?IResolvable | RuntimeConfigurationPropertyInstructions for how to launch and maintain server processes on instances in the fleet.
scriptId?stringThe unique identifier for a Realtime configuration script to be deployed on fleet instances.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrFleetId

Type: string

A unique identifier for the fleet.

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[]

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

name

Type: string

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

node

Type: ConstructNode

The construct tree node associated with this construct.

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

stack

Type: Stack

The stack in which this element is defined.

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

anywhereConfiguration?

Type: IResolvable | AnywhereConfigurationProperty (optional)

AWS::GameLift::Fleet.AnywhereConfiguration.

buildId?

Type: string (optional)

A unique identifier for a build to be deployed on the new fleet.

If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

certificateConfiguration?

Type: IResolvable | CertificateConfigurationProperty (optional)

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.

Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

computeType?

Type: string (optional)

The type of compute resource used to host your game servers.

You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

description?

Type: string (optional)

A description for the fleet.

desiredEc2Instances?

Type: number (optional)

The number of EC2 instances that you want this fleet to host.

When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

ec2InboundPermissions?

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

The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

ec2InstanceType?

Type: string (optional)

The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.

Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

fleetType?

Type: string (optional)

Indicates whether to use On-Demand or Spot instances for this fleet.

By default, this property is set to ON_DEMAND . Learn more about when to use On-Demand versus Spot Instances . This property cannot be changed after the fleet is created.

instanceRoleArn?

Type: string (optional)

A unique identifier for an IAM role that manages access to your AWS services.

With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This property cannot be changed after the fleet is created.

locations?

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

A set of remote locations to deploy additional instances to and manage as part of the fleet.

This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2 . To create a fleet with instances in the home Region only, don't use this parameter.

To use this parameter, Amazon GameLift requires you to use your home location in the request.

maxSize?

Type: number (optional)

The maximum number of instances that are allowed in the specified fleet location.

If this parameter is not set, the default is 1.

metricGroups?

Type: string[] (optional)

The name of an AWS CloudWatch metric group to add this fleet to.

A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

minSize?

Type: number (optional)

The minimum number of instances that are allowed in the specified fleet location.

If this parameter is not set, the default is 0.

newGameSessionProtectionPolicy?

Type: string (optional)

The status of termination protection for active game sessions on the fleet.

By default, this property is set to NoProtection .

  • NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
  • FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

peerVpcAwsAccountId?

Type: string (optional)

Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

You can find your account ID in the AWS Management Console under account settings.

peerVpcId?

Type: string (optional)

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.

The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .

resourceCreationLimitPolicy?

Type: IResolvable | ResourceCreationLimitPolicyProperty (optional)

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

runtimeConfiguration?

Type: IResolvable | RuntimeConfigurationProperty (optional)

Instructions for how to launch and maintain server processes on instances in the fleet.

The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

scriptId?

Type: string (optional)

The unique identifier for a Realtime configuration script to be deployed on fleet instances.

You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.

You can't use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
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)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.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
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).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

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.

addMetadata(key, value)

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

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [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.](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

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

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

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.

See also: [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.](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.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

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.

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 }
← PreviousNext →