class InitConfig

Language	Type name
.NET	Amazon.CDK.AWS.EC2.InitConfig
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsec2#InitConfig
Java	software.amazon.awscdk.services.ec2.InitConfig
Python	aws_cdk.aws_ec2.InitConfig
TypeScript (source)	aws-cdk-lib » aws_ec2 » InitConfig

A collection of configuration elements.

Example

declare const vpc: ec2.Vpc;
declare const instanceType: ec2.InstanceType;
declare const machineImage: ec2.IMachineImage;

new ec2.Instance(this, 'Instance', {
  vpc,
  instanceType,
  machineImage,

  // Showing the most complex setup, if you have simpler requirements
  // you can use `CloudFormationInit.fromElements()`.
  init: ec2.CloudFormationInit.fromConfigSets({
    configSets: {
      // Applies the configs below in this order
      default: ['yumPreinstall', 'config'],
    },
    configs: {
      yumPreinstall: new ec2.InitConfig([
        // Install an Amazon Linux package using yum
        ec2.InitPackage.yum('git'),
      ]),
      config: new ec2.InitConfig([
        // Create a JSON file from tokens (can also create other files)
        ec2.InitFile.fromObject('/etc/stack.json', {
          stackId: Stack.of(this).stackId,
          stackName: Stack.of(this).stackName,
          region: Stack.of(this).region,
        }),

        // Create a group and user
        ec2.InitGroup.fromName('my-group'),
        ec2.InitUser.fromName('my-user'),

        // Install an RPM from the internet
        ec2.InitPackage.rpm('http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm'),
      ]),
    },
  }),
  initOptions: {
    // Optional, which configsets to activate (['default'] by default)
    configSets: ['default'],

    // Optional, how long the installation is expected to take (5 minutes by default)
    timeout: Duration.minutes(30),

    // Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
    includeUrl: true,

    // Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
    includeRole: true,
  },
});

Initializer

new InitConfig(elements: InitElement[])

Parameters

• elements InitElement[]

Methods

Name	Description
add(...elements)	Add one or more elements to the config.
isEmpty()	Whether this configset has elements or not.

---

add(...elements)

public add(...elements: InitElement[]): void

Parameters

• elements InitElement

Add one or more elements to the config.

---

isEmpty()

public isEmpty(): boolean

Returns

• boolean

Whether this configset has elements or not.