aws-cdk-lib.aws_ec2.InitUser

class InitUser

LanguageType name
.NETAmazon.CDK.AWS.EC2.InitUser
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#InitUser
Javasoftware.amazon.awscdk.services.ec2.InitUser
Pythonaws_cdk.aws_ec2.InitUser
TypeScript (source)aws-cdk-lib » aws_ec2 » InitUser

Extends InitElement

Create Linux/UNIX users and to assign user IDs.

Users are created as non-interactive system users with a shell of /sbin/nologin. This is by design and cannot be modified.

Not supported for Windows systems.

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 (protected)

super(userName: string, userOptions: InitUserOptions)

Parameters

  • userName string
  • userOptions InitUserOptions

Properties

NameTypeDescription
elementTypestringReturns the init element type for this element.

elementType

Type: string

Returns the init element type for this element.

Methods

NameDescription
static fromName(userName, options?)Create a user from user name.

static fromName(userName, options?)

public static fromName(userName: string, options?: InitUserOptions): InitUser

Parameters

  • userName string
  • options InitUserOptions

Returns

  • InitUser

Create a user from user name.