Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . resiliencehubv2 ]

create-service

Description

Creates a service.

See also: AWS API Documentation

Synopsis

  create-service
--name <value>
[--description <value>]
[--associated-systems <value>]
[--policy-arn <value>]
--regions <value>
--permission-model <value>
[--dependency-discovery <value>]
[--report-configuration <value>]
[--kms-key-id <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--name (string)

Resource name (used in ARN — no spaces allowed).

--description (string)

Resource description for services and policies.

--associated-systems (list)

The systems to associate with the service.

(structure)

Represents a system associated with a service.

systemArn -> (string)

ARN identifier.

systemName -> (string)

Resource name (used in ARN — no spaces allowed).

userJourneyIds -> (list)

The list of user journey identifiers that associate this system with the service.

(string)

Shorthand Syntax:

systemArn=string,systemName=string,userJourneyIds=string,string ...

JSON Syntax:

[
  {
    "systemArn": "string",
    "systemName": "string",
    "userJourneyIds": ["string", ...]
  }
  ...
]

--policy-arn (string)

ARN identifier.

--regions (list)

The AWS Regions where the service operates.

(string)

Syntax:

"string" "string" ...

--permission-model (structure)

The permission model for the service.

invokerRoleName -> (string)

IAM role name (supports up to 64 characters per IAM limits).

crossAccountRoles -> (list)

The list of cross-account IAM role ARNs.

(structure)

Specifies a cross-account IAM role ARN and optional external ID.

crossAccountRoleArn -> (string)

ARN of the IAM Role for the profile. Null if the permission profile is the ‘Admin’ profile.

externalId -> (string)

The external ID used for assuming the cross-account role.

Shorthand Syntax:

invokerRoleName=string,crossAccountRoles=[{crossAccountRoleArn=string,externalId=string},{crossAccountRoleArn=string,externalId=string}]

JSON Syntax:

{
  "invokerRoleName": "string",
  "crossAccountRoles": [
    {
      "crossAccountRoleArn": "string",
      "externalId": "string"
    }
    ...
  ]
}

--dependency-discovery (string)

Caller-settable values for dependency discovery. INITIALIZING is system-managed.

Possible values:

• ENABLED
• DISABLED

--report-configuration (structure)

Configuration for automatic report generation on a Service.

reportOutputs -> (list)

Output destinations for generated reports.

(tagged union structure)

Configuration for a report output destination.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

S3 configuration for report output.

bucketPath -> (string)

S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).

bucketOwner -> (string)

Account ID of the bucket owner for cross-account access verification.

JSON Syntax:

{
  "reportOutputs": [
    {
      "s3": {
        "bucketPath": "string",
        "bucketOwner": "string"
      }
    }
    ...
  ]
}

--kms-key-id (string)

KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.

--tags (map)

Resource tags.

key -> (string)

Tag key.

value -> (string)

Tag value.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

Idempotency token.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

service -> (structure)

The created service.

serviceArn -> (string)

ARN identifier.

name -> (string)

Resource name (used in ARN — no spaces allowed).

description -> (string)

Resource description for services and policies.

associatedSystems -> (list)

The systems associated with the service.

(structure)

Represents a system associated with a service.

systemArn -> (string)

ARN identifier.

systemName -> (string)

Resource name (used in ARN — no spaces allowed).

userJourneyIds -> (list)

The list of user journey identifiers that associate this system with the service.

(string)

policyArn -> (string)

ARN identifier.

regions -> (list)

The AWS Regions where the service operates.

(string)

permissionModel -> (structure)

The permission model for the service.

invokerRoleName -> (string)

IAM role name (supports up to 64 characters per IAM limits).

crossAccountRoles -> (list)

The list of cross-account IAM role ARNs.

(structure)

Specifies a cross-account IAM role ARN and optional external ID.

crossAccountRoleArn -> (string)

ARN of the IAM Role for the profile. Null if the permission profile is the ‘Admin’ profile.

externalId -> (string)

The external ID used for assuming the cross-account role.

dependencyDiscovery -> (structure)

The dependency discovery configuration for the service.

status -> (string)

The current status of dependency discovery.

updatedAt -> (timestamp)

The timestamp when dependency discovery was last updated.

eligibleResourceCount -> (integer)

The count of resources eligible for dependency attribution.

message -> (string)

A status message for dependency discovery, displayed during the initialization state.

effectivePolicyValues -> (structure)

The effective policy values for the service.

availabilitySlo -> (structure)

The effective availability SLO value for the service.

value -> (double)

The availability SLO percentage value.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

multiAzRto -> (structure)

The effective multi-AZ RTO value for the service, in minutes.

value -> (integer)

The RTO or RPO value in minutes.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

multiAzRpo -> (structure)

The effective multi-AZ RPO value for the service, in minutes.

value -> (integer)

The RTO or RPO value in minutes.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

multiAzDrApproach -> (structure)

The effective multi-AZ disaster recovery approach for the service.

value -> (string)

The disaster recovery approach value.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

multiRegionRto -> (structure)

The effective multi-Region RTO value for the service, in minutes.

value -> (integer)

The RTO or RPO value in minutes.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

multiRegionRpo -> (structure)

The effective multi-Region RPO value for the service, in minutes.

value -> (integer)

The RTO or RPO value in minutes.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

multiRegionDrApproach -> (structure)

The effective multi-Region disaster recovery approach for the service.

value -> (string)

The disaster recovery approach value.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

dataRecoveryTimeBetweenBackups -> (structure)

The effective data recovery time between backups value for the service.

value -> (integer)

The RTO or RPO value in minutes.

policyName -> (string)

Resource name (used in ARN — no spaces allowed).

source -> (string)

Indicates whether the value comes from the service’s own account or a cross-account policy.

achievability -> (structure)

The achievability status of the service’s resilience targets.

availabilitySlo -> (string)

The achievability status of the availability SLO target for the service.

multiAzRtoRpo -> (string)

The achievability status of the multi-AZ RTO and RPO targets for the service.

multiRegionRtoRpo -> (string)

The achievability status of the multi-Region RTO and RPO targets for the service.

dataRecoveryTimeBetweenBackups -> (string)

The achievability status of the data recovery time between backups for the service.

reportConfiguration -> (structure)

Configuration for automatic report generation on a Service.

reportOutputs -> (list)

Output destinations for generated reports.

(tagged union structure)

Configuration for a report output destination.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

S3 configuration for report output.

bucketPath -> (string)

S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).

bucketOwner -> (string)

Account ID of the bucket owner for cross-account access verification.

kmsKeyId -> (string)

KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.

tags -> (map)

Resource tags.

key -> (string)

Tag key.

value -> (string)

Tag value.

estimatedAssessmentCost -> (structure)

The estimated cost of running an assessment on the service.

amount -> (double)

The cost amount for the assessment.

currency -> (string)

The currency of the assessment cost.

resourceDiscovery -> (structure)

The resource discovery status for the service.

status -> (string)

The current status of resource discovery.

lastRunAt -> (timestamp)

The timestamp of the last resource discovery run.

errorCode -> (string)

The error code if resource discovery failed.

errorMessage -> (string)

A message describing the error if resource discovery failed.

assessmentStatus -> (string)

The current assessment status of the service.

rerunAssessment -> (boolean)

Indicates whether the assessment should be rerun.

openFindingsCount -> (integer)

The number of open findings for the service.

resolvedFindingsCount -> (integer)

The number of resolved findings for the service.

organizationId -> (string)

The AWS Organizations identifier for the service.

ouId -> (string)

The organizational unit (OU) identifier for the service.

accountId -> (string)

The AWS account ID that owns the service.

createdAt -> (timestamp)

The timestamp when the service was created.

updatedAt -> (timestamp)

The timestamp when the service was last updated.