AWS CLI Command Reference

[ aws . ssm ]

register-default-host-management-configuration

Description

Enables Default Host Management Configuration (DHMC) for the current Amazon Web Services account and Amazon Web Services Region. With DHMC enabled, you don’t need to configure additional resources, such as an instance profile, to use your Amazon EC2 instances as managed nodes in Amazon Web Services Systems Manager.

To use this operation, you must have the following permissions:

  • You need the ssm:GetServiceSetting and ssm:UpdateServiceSetting permissions for the /ssm/managed-instance/default-ec2-instance-management-role service setting.
  • You need the iam:GetRole and iam:PassRole permissions for the role used for Default Host Management Configuration.

If PermissionModel is SERVICE_MANAGED , you also need the iam:CreateRole and iam:AttachRolePolicy permissions so that Amazon Web Services Systems Manager can create and configure the role on your behalf.

See also: AWS API Documentation

Synopsis

  register-default-host-management-configuration
--permission-model <value>
[--role-arn <value>]
[--overwrite | --no-overwrite]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--permission-model (string) [required]

The permission model that determines how the IAM role for Default Host Management Configuration is provided.

The permission model can be one of the following values:

SERVICE_MANAGED

Amazon Web Services Systems Manager creates and manages the role on your behalf.

SELF_MANAGED

You provide the role to register in RoleArn .

Possible values:

  • SERVICE_MANAGED
  • SELF_MANAGED

--role-arn (string)

The Amazon Resource Name (ARN) of the self-managed IAM role that you register for Default Host Management Configuration. The requirement for this value depends on the permission model:

  • If PermissionModel is SELF_MANAGED , this value is required.
  • If PermissionModel is SERVICE_MANAGED , this value must not be set.

Constraints:

  • min: 20
  • max: 2048
  • pattern: ^arn:aws[a-z0-9-]*:iam::\d{12}:role/[\w+=,.@/-]+$

--overwrite | --no-overwrite (boolean)

Specifies whether to override the role that is currently registered for Default Host Management Configuration. The default is false , which acts as a guardrail against accidentally replacing an existing configuration. Set this to true to replace the currently registered role.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

RoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role registered for Default Host Management Configuration. The value depends on the permission model:

SERVICE_MANAGED

The ARN of the role that Amazon Web Services Systems Manager created in the IAM reserved path.

SELF_MANAGED

The RoleArn that you provided.

Constraints:

  • min: 20
  • max: 2048
  • pattern: ^arn:aws[a-z0-9-]*:iam::\d{12}:role/[\w+=,.@/-]+$
© Copyright 2026, Amazon Web Services. Created using Sphinx.