diff --git a/awscli/examples/inspector2/create-filter.rst b/awscli/examples/inspector2/create-filter.rst new file mode 100644 index 000000000000..647807f2b527 --- /dev/null +++ b/awscli/examples/inspector2/create-filter.rst @@ -0,0 +1,17 @@ +**To create a filter** + +The following ``create-filter`` example creates a suppression rule that omits ECR instance type findings. :: + + aws inspector2 create-filter \ + --name "ExampleSuppressionRuleECR" \ + --description "This suppression rule omits ECR instance type findings" \ + --action SUPPRESS \ + --filter-criteria 'resourceType=[{comparison="EQUALS", value="AWS_ECR_INSTANCE"}]' + +Output:: + + { + "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" + } + +For more information, see `Filtering Amazon Inspector findings `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/create-findings-report.rst b/awscli/examples/inspector2/create-findings-report.rst new file mode 100644 index 000000000000..cfdb05092504 --- /dev/null +++ b/awscli/examples/inspector2/create-findings-report.rst @@ -0,0 +1,16 @@ +**To create a findings report** + +The following ``create-findings-report`` example creates a finding report. :: + + aws inspector2 create-findings-report \ + --report-format CSV \ + --s3-destination bucketName=inspector-sbom-123456789012,keyPrefix=sbom-key,kmsKeyArn=arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 \ + --filter-criteria '{"ecrImageRepositoryName":[{"comparison":"EQUALS","value":"debian"}]}' + +Output:: + + { + "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" + } + +For more information, see `Managing findings in Amazon Inspector `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/create-sbom-export.rst b/awscli/examples/inspector2/create-sbom-export.rst new file mode 100644 index 000000000000..4de14dd5765f --- /dev/null +++ b/awscli/examples/inspector2/create-sbom-export.rst @@ -0,0 +1,16 @@ +**To create a software bill of materials (SBOM) report** + +The following ``create-sbom-export`` example creates a software bill of materials (SBOM) report. :: + + aws inspector2 create-sbom-export \ + --report-format SPDX_2_3 \ + --resource-filter-criteria 'ecrRepositoryName=[{comparison="EQUALS",value="debian"}]' \ + --s3-destination bucketName=inspector-sbom-123456789012,keyPrefix=sbom-key,kmsKeyArn=arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 + +Output:: + + { + "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" + } + +For more information, see `Exporting SBOMs with Amazon Inspector `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/delete-filter.rst b/awscli/examples/inspector2/delete-filter.rst new file mode 100644 index 000000000000..d7543a0a263a --- /dev/null +++ b/awscli/examples/inspector2/delete-filter.rst @@ -0,0 +1,14 @@ +**To delete a filter** + +The following ``delete-filter`` example deletes a filter. :: + + aws inspector2 delete-filter \ + --arn "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" + +Output:: + + { + "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" + } + +For more information, see `Filtering Amazon Inspector findings `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/get-configuration.rst b/awscli/examples/inspector2/get-configuration.rst new file mode 100644 index 000000000000..e8cd1790dc52 --- /dev/null +++ b/awscli/examples/inspector2/get-configuration.rst @@ -0,0 +1,26 @@ +**To get the setting configuration for Inspector scans** + +The following ``get-configuration`` example gets the setting configuration for Inspector scans. :: + + aws inspector2 get-configuration + +Output:: + + { + "ec2Configuration": { + "scanModeState": { + "scanMode": "EC2_HYBRID", + "scanModeStatus": "SUCCESS" + } + }, + "ecrConfiguration": { + "rescanDurationState": { + "pullDateRescanDuration": "DAYS_90", + "rescanDuration": "DAYS_30", + "status": "SUCCESS", + "updatedAt": "2024-05-14T21:16:20.237000+00:00" + } + } + } + +For more information, see `Automated resource scanning with Amazon Inspector `__ in the *Amazon Inspector User Guide*. \ No newline at end of file diff --git a/awscli/examples/inspector2/list-account-permissions.rst b/awscli/examples/inspector2/list-account-permissions.rst new file mode 100644 index 000000000000..23bfa449f88c --- /dev/null +++ b/awscli/examples/inspector2/list-account-permissions.rst @@ -0,0 +1,46 @@ +**To list account permissions** + +The following ``list-account-permissions`` example lists your account permissions. :: + + aws inspector2 list-account-permissions + +Output:: + + { + "permissions": [ + { + "operation": "ENABLE_SCANNING", + "service": "ECR" + }, + { + "operation": "DISABLE_SCANNING", + "service": "ECR" + }, + { + "operation": "ENABLE_REPOSITORY", + "service": "ECR" + }, + { + "operation": "DISABLE_REPOSITORY", + "service": "ECR" + }, + { + "operation": "ENABLE_SCANNING", + "service": "EC2" + }, + { + "operation": "DISABLE_SCANNING", + "service": "EC2" + }, + { + "operation": "ENABLE_SCANNING", + "service": "LAMBDA" + }, + { + "operation": "DISABLE_SCANNING", + "service": "LAMBDA" + } + ] + } + +For more information, see `Identity and Access Management for Amazon Inspector `__ in the *Amazon Inspector User Guide*. \ No newline at end of file diff --git a/awscli/examples/inspector2/list-coverage-statistics.rst b/awscli/examples/inspector2/list-coverage-statistics.rst new file mode 100644 index 000000000000..a2793e82b767 --- /dev/null +++ b/awscli/examples/inspector2/list-coverage-statistics.rst @@ -0,0 +1,80 @@ +**Example 1: To list coverage statistics by groups** + +The following ``list-coverage-statistics`` example lists the coverage statistics of your AWS environment by groups. :: + + aws inspector2 list-coverage-statistics \ + --group-by RESOURCE_TYPE + +Output:: + + { + "countsByGroup": [ + { + "count": 56, + "groupKey": "AWS_LAMBDA_FUNCTION" + }, + { + "count": 27, + "groupKey": "AWS_ECR_REPOSITORY" + }, + { + "count": 18, + "groupKey": "AWS_EC2_INSTANCE" + }, + { + "count": 3, + "groupKey": "AWS_ECR_CONTAINER_IMAGE" + }, + { + "count": 1, + "groupKey": "AWS_ACCOUNT" + } + ], + "totalCounts": 105 + } + +For more information, see `Assessing Amazon Inspector coverage of your AWS environment `__ in the *Amazon Inspector User Guide*. + +**Example 2: To list coverage statistics by resource type** + +The following ``list-coverage-statistics`` example lists the coverage statistics of your AWS environment by resource type. :: + + aws inspector2 list-coverage-statistics + --filter-criteria '{"resourceType":[{"comparison":"EQUALS","value":"AWS_ECR_REPOSITORY"}]}' + --group-by SCAN_STATUS_REASON + +Output:: + + { + "countsByGroup": [ + { + "count": 27, + "groupKey": "SUCCESSFUL" + } + ], + "totalCounts": 27 + } + +For more information, see `Assessing Amazon Inspector coverage of your AWS environment `__ in the *Amazon Inspector User Guide*. + +**Example 3: To list coverage statistics by ECR repository name** + +The following ``list-coverage-statistics`` example lists the coverage statistics of your AWS environment by ECR repository name. :: + + aws inspector2 list-coverage-statistics + --filter-criteria '{"ecrRepositoryName":[{"comparison":"EQUALS","value":"debian"}]}' + --group-by SCAN_STATUS_REASON + +Output:: + + { + "countsByGroup": [ + { + "count": 3, + "groupKey": "SUCCESSFUL" + } + ], + "totalCounts": 3 + } + +For more information, see `Assessing Amazon Inspector coverage of your AWS environment `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/list-coverage.rst b/awscli/examples/inspector2/list-coverage.rst new file mode 100644 index 000000000000..e2316ae75a0f --- /dev/null +++ b/awscli/examples/inspector2/list-coverage.rst @@ -0,0 +1,61 @@ +**Example 1: To list coverage details about your environment** + +The following ``list-coverage`` example lists your environment's coverage details. :: + + aws inspector2 list-coverage + +Output:: + + { + "coveredResources": [ + { + "accountId": "123456789012", + "lastScannedAt": "2024-05-20T16:23:20-07:00", + "resourceId": "i-EXAMPLE55555555555", + "resourceMetadata": { + "ec2": { + "amiId": "ami-EXAMPLE6666666666", + "platform": "LINUX" + } + }, + "resourceType": "AWS_EC2_INSTANCE", + "scanStatus": { + "reason": "SUCCESSFUL", + "statusCode": "ACTIVE" + }, + "scanType": "PACKAGE" + } + ] + } + +**Example 2: To list coverage details about the Lambda function resource type** + +The following ``list-coverage`` example lists your Lamda function resource type details. :: + + aws inspector2 list-coverage + --filter-criteria '{"resourceType":[{"comparison":"EQUALS","value":"AWS_LAMBDA_FUNCTION"}]}' + +Output:: + + { + "coveredResources": [ + { + "accountId": "123456789012", + "resourceId": "arn:aws:lambda:us-west-2:123456789012:function:Eval-container-scan-results:$LATEST", + "resourceMetadata": { + "lambdaFunction": { + "functionName": "Eval-container-scan-results", + "functionTags": {}, + "layers": [], + "runtime": "PYTHON_3_7" + } + }, + "resourceType": "AWS_LAMBDA_FUNCTION", + "scanStatus": { + "reason": "SUCCESSFUL", + "statusCode": "ACTIVE" + }, + "scanType": "CODE" + } + ] + } diff --git a/awscli/examples/inspector2/list-delegated-admin-accounts.rst b/awscli/examples/inspector2/list-delegated-admin-accounts.rst new file mode 100644 index 000000000000..fb877f34b447 --- /dev/null +++ b/awscli/examples/inspector2/list-delegated-admin-accounts.rst @@ -0,0 +1,18 @@ +**To list information about the delegated administrator account of your organization** + +The following ``list-delegated-admin-accounts`` example lists information about the delegated administrator account of your organization. :: + + aws inspector2 list-delegated-admin-accounts + +Output:: + + { + "delegatedAdminAccounts": [ + { + "accountId": "123456789012", + "status": "ENABLED" + } + ] + } + +For more information, see `Designating a delegated administrator for Amazon Inspector `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/list-filters.rst b/awscli/examples/inspector2/list-filters.rst new file mode 100644 index 000000000000..11da430104db --- /dev/null +++ b/awscli/examples/inspector2/list-filters.rst @@ -0,0 +1,50 @@ +**To list filters associated with the account that you used to activated Amazon Inspector** + +The following ``list-filters`` examples lists filters associated with the account that you used to activated Amazon Inspector. :: + + aws inspector2 list-filters + +Output:: + + { + "filters": [ + { + "action": "SUPPRESS", + "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444", + "createdAt": "2024-05-15T21:11:08.602000+00:00", + "criteria": { + "resourceType": [ + { + "comparison": "EQUALS", + "value": "AWS_EC2_INSTANCE" + }, + ] + }, + "description": "This suppression rule omits EC2 instance type findings", + "name": "ExampleSuppressionRuleEC2", + "ownerId": "o-EXAMPLE222", + "tags": {}, + "updatedAt": "2024-05-15T21:11:08.602000+00:00" + }, + { + "action": "SUPPRESS", + "arn": "arn:aws:inspector2:us-east-1:813737243517:owner/o-EXAMPLE222/filter/EXAMPLE444444444", + "createdAt": "2024-05-15T21:28:27.054000+00:00", + "criteria": { + "resourceType": [ + { + "comparison": "EQUALS", + "value": "AWS_ECR_INSTANCE" + } + ] + }, + "description": "This suppression rule omits ECR instance type findings", + "name": "ExampleSuppressionRuleECR", + "ownerId": "o-EXAMPLE222", + "tags": {}, + "updatedAt": "2024-05-15T21:28:27.054000+00:00" + } + ] + } + +For more information, see `Filtering Amazon Inspector findings `__ in the *Amazon Inspector User Guide*. diff --git a/awscli/examples/inspector2/list-usage-totals.rst b/awscli/examples/inspector2/list-usage-totals.rst new file mode 100644 index 000000000000..ada17c6f8ffa --- /dev/null +++ b/awscli/examples/inspector2/list-usage-totals.rst @@ -0,0 +1,55 @@ +**To list usage totals over the last 30 days** + +The following ``list-usage-totals`` examples lists usage totals over the last 30 days. :: + + aws inspector2 list-usage-totals + +Output:: + + { + "totals": [ + { + "accountId": "123456789012", + "usage": [ + { + "currency": "USD", + "estimatedMonthlyCost": 4.6022044647, + "total": 1893.4784083333334, + "type": "EC2_AGENTLESS_INSTANCE_HOURS" + }, + { + "currency": "USD", + "estimatedMonthlyCost": 18.892449279, + "total": 10882.050784722222, + "type": "EC2_INSTANCE_HOURS" + }, + { + "currency": "USD", + "estimatedMonthlyCost": 5.4525363736, + "total": 6543.043648333333, + "type": "LAMBDA_FUNCTION_CODE_HOURS" + }, + { + "currency": "USD", + "estimatedMonthlyCost": 3.9064080309, + "total": 9375.379274166668, + "type": "LAMBDA_FUNCTION_HOURS" + }, + { + "currency": "USD", + "estimatedMonthlyCost": 0.06, + "total": 6.0, + "type": "ECR_RESCAN" + }, + { + "currency": "USD", + "estimatedMonthlyCost": 0.09, + "total": 1.0, + "type": "ECR_INITIAL_SCAN" + } + ] + } + ] + } + +For more information, see `Monitoring usage and cost in Amazon Inspector `__ in the *Amazon Inspector User Guide*. \ No newline at end of file diff --git a/awscli/examples/inspector2/update-filter.rst b/awscli/examples/inspector2/update-filter.rst new file mode 100644 index 000000000000..a3d98f10d08c --- /dev/null +++ b/awscli/examples/inspector2/update-filter.rst @@ -0,0 +1,37 @@ +**To update a filter** + +The following ``update-filter`` example updates a filter to omit Lambda findings instead of ECR instance findings. :: + + aws inspector2 update-filter \ + --filter-arn "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" \ + --name "ExampleSuppressionRuleLambda" \ + --description "This suppression rule omits Lambda instance findings" \ + --reason "Updating filter to omit Lambda instance findings instead of ECR instance findings" + +Output:: + + { + "filters": [ + { + "action": "SUPPRESS", + "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444", + "createdAt": "2024-05-15T21:28:27.054000+00:00", + "criteria": { + "resourceType": [ + { + "comparison": "EQUALS", + "value": "AWS_ECR_INSTANCE" + } + ] + }, + "description": "This suppression rule omits Lambda instance findings", + "name": "ExampleSuppressionRuleLambda", + "ownerId": "o-EXAMPLE222", + "reason": "Updating filter to omit Lambda instance findings instead of ECR instance findings", + "tags": {}, + "updatedAt": "2024-05-15T22:23:13.665000+00:00" + } + ] + } + +For more information, see `Managing findings in Amazon Inspector `__ in the *Amazon Inspector User Guide*. \ No newline at end of file diff --git a/awscli/examples/lightsail/create-instances-from-snapshot.rst b/awscli/examples/lightsail/create-instances-from-snapshot.rst index 34e4d2200901..a432a1d82a42 100644 --- a/awscli/examples/lightsail/create-instances-from-snapshot.rst +++ b/awscli/examples/lightsail/create-instances-from-snapshot.rst @@ -1,6 +1,6 @@ **To create an instance from a snapshot** -The following ``create-instances-from-snapshot`` example creates an instance from the specified instance snapshot, in the specified AWS Region and Availability Zone, using the $10 USD bundle. +The following ``create-instances-from-snapshot`` example creates an instance from the specified instance snapshot, in the specified AWS Region and Availability Zone, using the $12 USD bundle. **Note:** The bundle that you specify must be equal to or greater in specifications than the bundle of the original source instance used to create the snapshot. :: @@ -8,7 +8,7 @@ The following ``create-instances-from-snapshot`` example creates an instance fro --instance-snapshot-name WordPress-1-1569866208 \ --instance-names WordPress-2 \ --availability-zone us-west-2a \ - --bundle-id medium_2_0 + --bundle-id small_3_0 Output:: @@ -29,4 +29,4 @@ Output:: "statusChangedAt": 1569865914.908 } ] - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/create-instances.rst b/awscli/examples/lightsail/create-instances.rst index 7850fd1a80d9..bcf2d49cf844 100644 --- a/awscli/examples/lightsail/create-instances.rst +++ b/awscli/examples/lightsail/create-instances.rst @@ -1,12 +1,12 @@ **Example 1: To create a single instance** -The following ``create-instances`` example creates an instance in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $3.50 USD bundle. :: +The following ``create-instances`` example creates an instance in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $5.00 USD bundle. :: aws lightsail create-instances \ --instance-names Instance-1 \ --availability-zone us-west-2a \ - --blueprint-id wordpress_5_1_1_2 \ - --bundle-id nano_2_0 + --blueprint-id wordpress \ + --bundle-id nano_3_0 Output:: @@ -31,13 +31,13 @@ Output:: **Example 2: To create multiple instances at one time** -The following ``create-instances`` example creates three instances in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $3.50 USD bundle. :: +The following ``create-instances`` example creates three instances in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $5.00 USD bundle. :: aws lightsail create-instances \ --instance-names {"Instance1","Instance2","Instance3"} \ --availability-zone us-west-2a \ - --blueprint-id wordpress_5_1_1_2 \ - --bundle-id nano_2_0 + --blueprint-id wordpress \ + --bundle-id nano_3_0 Output:: @@ -86,4 +86,4 @@ Output:: "statusChangedAt": 1569448780.054 } ] - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/get-blueprints.rst b/awscli/examples/lightsail/get-blueprints.rst index 61859a95cacc..04c6d84cf074 100644 --- a/awscli/examples/lightsail/get-blueprints.rst +++ b/awscli/examples/lightsail/get-blueprints.rst @@ -16,24 +16,24 @@ Output:: "description": "Bitnami, the leaders in application packaging, and Automattic, the experts behind WordPress, have teamed up to offer this official WordPress image. This image is a pre-configured, ready-to-run image for running WordPress on Amazon Lightsail. WordPress is the world's most popular content management platform. Whether it's for an enterprise or small business website, or a personal or corporate blog, content authors can easily create content using its new Gutenberg editor, and developers can extend the base platform with additional features. Popular plugins like Jetpack, Akismet, All in One SEO Pack, WP Mail, Google Analytics for WordPress, and Amazon Polly are all pre-installed in this image. Let's Encrypt SSL certificates are supported through an auto-configuration script.", "isActive": true, "minPower": 0, - "version": "5.2.2-3", + "version": "6.5.3-0", "versionCode": "1", "productUrl": "https://aws.amazon.com/marketplace/pp/B00NN8Y43U", - "licenseUrl": "https://d7umqicpi7263.cloudfront.net/eula/product/7d426cb7-9522-4dd7-a56b-55dd8cc1c8d0/588fd495-6492-4610-b3e8-d15ce864454c.txt", + "licenseUrl": "https://aws.amazon.com/marketplace/pp/B00NN8Y43U#pdp-usage", "platform": "LINUX_UNIX" }, { - "blueprintId": "lamp_7_1_28", - "name": "LAMP (PHP 7)", - "group": "lamp_7", + "blueprintId": "lamp_8_bitnami", + "name": "LAMP (PHP 8)", + "group": "lamp_8", "type": "app", - "description": "LAMP with PHP 7.x certified by Bitnami greatly simplifies the development and deployment of PHP applications. It includes the latest versions of PHP 7.x, Apache and MySQL together with phpMyAdmin and popular PHP frameworks Zend, Symfony, CodeIgniter, CakePHP, Smarty, and Laravel. Other pre-configured components and PHP modules include FastCGI, ModSecurity, SQLite, Varnish, ImageMagick, xDebug, Xcache, OpenLDAP, Memcache, OAuth, PEAR, PECL, APC, GD and cURL. It is secure by default and supports multiple applications, each with its own virtual host and project directory. Let's Encrypt SSL certificates are supported through an auto-configuration script.", + "description": "LAMP with PHP 8.X packaged by Bitnami enables you to quickly start building your websites and applications by providing a coding framework. As a developer, it provides standalone project directories to store your applications. This blueprint is configured for production environments. It includes SSL auto-configuration with Let's Encrypt certificates, and the latest releases of PHP, Apache, and MariaDB on Linux. This application also includes phpMyAdmin, PHP main modules and Composer.", "isActive": true, "minPower": 0, - "version": "7.1.28", + "version": "8.2.18-4", "versionCode": "1", - "productUrl": "https://aws.amazon.com/marketplace/pp/B072JNJZ5C", - "licenseUrl": "https://d7umqicpi7263.cloudfront.net/eula/product/cb6afd05-a3b2-4916-a3e6-bccd414f5f21/12ab56cc-6a8c-4977-9611-dcd770824aad.txt", + "productUrl": "https://aws.amazon.com/marketplace/pp/prodview-6g3gzfcih6dvu", + "licenseUrl": "https://aws.amazon.com/marketplace/pp/prodview-6g3gzfcih6dvu#pdp-usage", "platform": "LINUX_UNIX" }, { @@ -41,16 +41,16 @@ Output:: "name": "Node.js", "group": "node", "type": "app", - "description": "Node.js certified by Bitnami is a pre-configured, ready to run image for Node.js on Amazon EC2. It includes the latest version of Node.js, Apache, Python and Redis. The image supports multiple Node.js applications, each with its own virtual host and project directory. It is configured for production use and is secure by default, as all ports except HTTP, HTTPS and SSH ports are closed. Let's Encrypt SSL certificates are supported through an auto-configuration script. Developers benefit from instant access to a secure, update and consistent Node.js environment without having to manually install and configure multiple components and libraries.", + "description": "Node.js packaged by Bitnami is a pre-configured, ready to run image for Node.js on Amazon EC2. It includes the latest version of Node.js, Apache, Python and Redis. The image supports multiple Node.js applications, each with its own virtual host and project directory. It is configured for production use and is secure by default, as all ports except HTTP, HTTPS and SSH ports are closed. Let's Encrypt SSL certificates are supported through an auto-configuration script. Developers benefit from instant access to a secure, update and consistent Node.js environment without having to manually install and configure multiple components and libraries.", "isActive": true, "minPower": 0, - "version": "12.7.0", + "version": "18.20.2-0", "versionCode": "1", "productUrl": "https://aws.amazon.com/marketplace/pp/B00NNZUAKO", - "licenseUrl": "https://d7umqicpi7263.cloudfront.net/eula/product/033793fe-951d-47d0-aa94-5fbd0afb3582/25f8fa66-c868-4d80-adf8-4a2b602064ae.txt", + "licenseUrl": "https://aws.amazon.com/marketplace/pp/B00NNZUAKO#pdp-usage", "platform": "LINUX_UNIX" }, ... } ] - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/get-bundles.rst b/awscli/examples/lightsail/get-bundles.rst index 1624015cb2ef..b2c95da027e5 100644 --- a/awscli/examples/lightsail/get-bundles.rst +++ b/awscli/examples/lightsail/get-bundles.rst @@ -9,14 +9,14 @@ Output:: { "bundles": [ { - "price": 3.5, - "cpuCount": 1, + "price": 5.0, + "cpuCount": 2, "diskSizeInGb": 20, - "bundleId": "nano_2_0", + "bundleId": "nano_3_0", "instanceType": "nano", "isActive": true, "name": "Nano", - "power": 300, + "power": 298, "ramSizeInGb": 0.5, "transferPerMonthInGb": 1024, "supportedPlatforms": [ @@ -24,10 +24,10 @@ Output:: ] }, { - "price": 5.0, - "cpuCount": 1, + "price": 7.0, + "cpuCount": 2, "diskSizeInGb": 40, - "bundleId": "micro_2_0", + "bundleId": "micro_3_0", "instanceType": "micro", "isActive": true, "name": "Micro", @@ -39,10 +39,10 @@ Output:: ] }, { - "price": 10.0, - "cpuCount": 1, + "price": 12.0, + "cpuCount": 2, "diskSizeInGb": 60, - "bundleId": "small_2_0", + "bundleId": "small_3_0", "instanceType": "small", "isActive": true, "name": "Small", @@ -56,4 +56,4 @@ Output:: ... } ] - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/get-instance-snapshot.rst b/awscli/examples/lightsail/get-instance-snapshot.rst index b776fb4a842a..e5358fff1f49 100644 --- a/awscli/examples/lightsail/get-instance-snapshot.rst +++ b/awscli/examples/lightsail/get-instance-snapshot.rst @@ -23,9 +23,9 @@ Output:: "fromAttachedDisks": [], "fromInstanceName": "MEAN-1", "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", - "fromBlueprintId": "mean_4_0_9", - "fromBundleId": "medium_2_0", + "fromBlueprintId": "mean", + "fromBundleId": "medium_3_0", "isFromAutoSnapshot": false, "sizeInGb": 80 } - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/get-instance-snapshots.rst b/awscli/examples/lightsail/get-instance-snapshots.rst index 6f9a5a414b6b..0d6662cbe9c4 100644 --- a/awscli/examples/lightsail/get-instance-snapshots.rst +++ b/awscli/examples/lightsail/get-instance-snapshots.rst @@ -27,8 +27,8 @@ Output:: "fromAttachedDisks": [], "fromInstanceName": "MEAN-1", "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/1761aa0a-6038-4f25-8b94-2EXAMPLE19fd", - "fromBlueprintId": "wordpress_5_1_1_2", - "fromBundleId": "micro_2_0", + "fromBlueprintId": "wordpress", + "fromBundleId": "micro_3_0", "isFromAutoSnapshot": false, "sizeInGb": 40 }, @@ -47,10 +47,10 @@ Output:: "fromAttachedDisks": [], "fromInstanceName": "MEAN-1", "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", - "fromBlueprintId": "mean_4_0_9", - "fromBundleId": "medium_2_0", + "fromBlueprintId": "mean", + "fromBundleId": "medium_3_0", "isFromAutoSnapshot": false, "sizeInGb": 80 } ] - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/get-instance.rst b/awscli/examples/lightsail/get-instance.rst index 3d66d785d0c4..a41a757a988a 100644 --- a/awscli/examples/lightsail/get-instance.rst +++ b/awscli/examples/lightsail/get-instance.rst @@ -19,9 +19,9 @@ Output:: }, "resourceType": "Instance", "tags": [], - "blueprintId": "mean_4_0_9", + "blueprintId": "mean", "blueprintName": "MEAN", - "bundleId": "medium_2_0", + "bundleId": "medium_3_0", "isStaticIp": false, "privateIpAddress": "192.0.2.0", "publicIpAddress": "192.0.2.0", @@ -33,7 +33,7 @@ Output:: "sizeInGb": 80, "isSystemDisk": true, "iops": 240, - "path": "/dev/sda1", + "path": "/dev/xvda", "attachedTo": "MEAN-1", "attachmentState": "attached" } @@ -81,4 +81,4 @@ Output:: "username": "bitnami", "sshKeyName": "MyKey" } - } + } \ No newline at end of file diff --git a/awscli/examples/lightsail/get-instances.rst b/awscli/examples/lightsail/get-instances.rst index 10bb9221105a..049e4af65e80 100644 --- a/awscli/examples/lightsail/get-instances.rst +++ b/awscli/examples/lightsail/get-instances.rst @@ -9,7 +9,7 @@ Output:: { "instances": [ { - "name": "Windows_Server_2016-1", + "name": "Windows_Server_2022-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/0f44fbb9-8f55-4e47-a25e-EXAMPLE04763", "supportCode": "62EXAMPLE362/i-0bEXAMPLE71a686b9", "createdAt": 1571332358.665, @@ -19,9 +19,9 @@ Output:: }, "resourceType": "Instance", "tags": [], - "blueprintId": "windows_server_2016", - "blueprintName": "Windows Server 2016", - "bundleId": "small_win_2_0", + "blueprintId": "windows_server_2022", + "blueprintName": "Windows Server 2022", + "bundleId": "large_win_3_0", "isStaticIp": false, "privateIpAddress": "192.0.2.0", "publicIpAddress": "192.0.2.0", @@ -30,11 +30,11 @@ Output:: "disks": [ { "createdAt": 1571332358.665, - "sizeInGb": 60, + "sizeInGb": 160, "isSystemDisk": true, "iops": 180, "path": "/dev/sda1", - "attachedTo": "Windows_Server_2016-1", + "attachedTo": "Windows_Server_2022-1", "attachmentState": "attached" }, { @@ -53,12 +53,12 @@ Output:: "iops": 384, "path": "/dev/xvdf", "state": "in-use", - "attachedTo": "Windows_Server_2016-1", + "attachedTo": "Windows_Server_2022-1", "isAttached": true, "attachmentState": "attached" } ], - "ramSizeInGb": 2.0 + "ramSizeInGb": 8.0 }, "networking": { "monthlyTransfer": { @@ -112,9 +112,9 @@ Output:: }, "resourceType": "Instance", "tags": [], - "blueprintId": "mean_4_0_9", + "blueprintId": "mean", "blueprintName": "MEAN", - "bundleId": "medium_2_0", + "bundleId": "medium_3_0", "isStaticIp": false, "privateIpAddress": "192.0.2.0", "publicIpAddress": "192.0.2.0", @@ -138,7 +138,7 @@ Output:: ], "sizeInGb": 8, "isSystemDisk": false, - "iops": 100, + "iops": 240, "path": "/dev/xvdf", "state": "in-use", "attachedTo": "MEAN-1", @@ -199,4 +199,4 @@ Output:: "sshKeyName": "MyTestKey" } ] - } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/associate-profile.rst b/awscli/examples/route53profiles/associate-profile.rst new file mode 100644 index 000000000000..f9c8a7efecfd --- /dev/null +++ b/awscli/examples/route53profiles/associate-profile.rst @@ -0,0 +1,26 @@ +**To associate a Profile** + +The following ``associate-profile`` example associates a Profile to a VPC. :: + + aws route53profiles associate-profile \ + --name test-association \ + --profile-id rp-4987774726example \ + --resource-id vpc-0af3b96b3example + +Output:: + + { + "ProfileAssociation": { + "CreationTime": 1710851336.527, + "Id": "rpassoc-489ce212fexample", + "ModificationTime": 1710851336.527, + "Name": "test-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceId": "vpc-0af3b96b3example", + "Status": "CREATING", + "StatusMessage": "Creating Profile Association" + } + } + +For more information, see `Using Profiles `__ in the *Amazon Route 53 Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/route53profiles/associate-resource-to-profile.rst b/awscli/examples/route53profiles/associate-resource-to-profile.rst new file mode 100644 index 000000000000..80c144cef84e --- /dev/null +++ b/awscli/examples/route53profiles/associate-resource-to-profile.rst @@ -0,0 +1,28 @@ +**To associate a resource to a Profile** + +The following ``associate-resource-to-profile`` example associates a DNS Firewall rule group with the priority of 102 to a Profile. :: + + aws route53profiles associate-resource-to-profile \ + --name test-resource-association \ + --profile-id rp-4987774726example \ + --resource-arn arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example \ + --resource-properties "{\"priority\": 102}" + +Output:: + + { + "ProfileResourceAssociation": { + "CreationTime": 1710851216.613, + "Id": "rpr-001913120a7example", + "ModificationTime": 1710851216.613, + "Name": "test-resource-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceArn": "arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example", + "ResourceProperties": "{\"priority\":102}", + "ResourceType": "FIREWALL_RULE_GROUP", + "Status": "UPDATING", + "StatusMessage": "Updating the Profile to DNS Firewall rule group association" + } + } + diff --git a/awscli/examples/route53profiles/create-profile.rst b/awscli/examples/route53profiles/create-profile.rst new file mode 100644 index 000000000000..e45db24e3e85 --- /dev/null +++ b/awscli/examples/route53profiles/create-profile.rst @@ -0,0 +1,23 @@ +**To create a Profile** + +The following ``create-profile`` example creates a Profile. :: + + aws route53profiles create-profile \ + --name test + +Output:: + + { + "Profile": { + "Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-6ffe47d5example", + "ClientToken": "2ca1a304-32b3-4f5f-bc4c-EXAMPLE11111", + "CreationTime": 1710850903.578, + "Id": "rp-6ffe47d5example", + "ModificationTime": 1710850903.578, + "Name": "test", + "OwnerId": "123456789012", + "ShareStatus": "NOT_SHARED", + "Status": "COMPLETE", + "StatusMessage": "Created Profile" + } + } diff --git a/awscli/examples/route53profiles/delete-profile.rst b/awscli/examples/route53profiles/delete-profile.rst new file mode 100644 index 000000000000..d20b5c39649d --- /dev/null +++ b/awscli/examples/route53profiles/delete-profile.rst @@ -0,0 +1,23 @@ +**To delete a Profile** + +The following ``delete-profile`` example deletes a Profile. :: + + aws route53profiles delete-profile \ + --profile-id rp-6ffe47d5example + +Output:: + + { + "Profile": { + "Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-6ffe47d5example", + "ClientToken": "0a15fec0-05d9-4f78-bec0-EXAMPLE11111", + "CreationTime": 1710850903.578, + "Id": "rp-6ffe47d5example", + "ModificationTime": 1710850903.578, + "Name": "test", + "OwnerId": "123456789012", + "ShareStatus": "NOT_SHARED", + "Status": "DELETED", + "StatusMessage": "Deleted Profile" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/disassociate-profile.rst b/awscli/examples/route53profiles/disassociate-profile.rst new file mode 100644 index 000000000000..e005d592b754 --- /dev/null +++ b/awscli/examples/route53profiles/disassociate-profile.rst @@ -0,0 +1,23 @@ +**To disassociate a Profile** + +The following ``disassociate-profile`` example disassociates a Profile from a VPC. :: + + aws route53profiles disassociate-profile \ + --profile-id rp-4987774726example \ + --resource-id vpc-0af3b96b3example + +Output:: + + { + "ProfileAssociation": { + "CreationTime": 1710851336.527, + "Id": "rpassoc-489ce212fexample", + "ModificationTime": 1710851401.362, + "Name": "test-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceId": "vpc-0af3b96b3example", + "Status": "DELETING", + "StatusMessage": "Deleting Profile Association" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/disassociate-resource-from-profile.rst b/awscli/examples/route53profiles/disassociate-resource-from-profile.rst new file mode 100644 index 000000000000..a1427e647172 --- /dev/null +++ b/awscli/examples/route53profiles/disassociate-resource-from-profile.rst @@ -0,0 +1,25 @@ +**To disassociate a resource from Profile** + +The following ``disassociate-resource-from-profile`` example disassociates a DNS Firewall rule group from a Profile. :: + + aws route53profiles disassociate-resource-from-profile \ + --profile-id rp-4987774726example \ + --resource-arn arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example + +Output:: + + { + "ProfileResourceAssociation": { + "CreationTime": 1710851216.613, + "Id": "rpr-001913120a7example", + "ModificationTime": 1710852624.36, + "Name": "test-resource-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceArn": "arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example", + "ResourceProperties": "{\"priority\":105}", + "ResourceType": "FIREWALL_RULE_GROUP", + "Status": "DELETING", + "StatusMessage": "Deleting the Profile to DNS Firewall rule group association" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/get-profile-association.rst b/awscli/examples/route53profiles/get-profile-association.rst new file mode 100644 index 000000000000..764b1f63db0c --- /dev/null +++ b/awscli/examples/route53profiles/get-profile-association.rst @@ -0,0 +1,22 @@ +**To get information about a Profile association** + +The following ``get-profile-association`` returns information about the specified Profile association. :: + + aws route53profiles get-profile-association \ + --profile-association-id rpassoc-489ce212fexample + +Output:: + + { + "ProfileAssociation": { + "CreationTime": 1709338817.148, + "Id": "rrpassoc-489ce212fexample", + "ModificationTime": 1709338974.772, + "Name": "test-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceId": "vpc-0af3b96b3example", + "Status": "COMPLETE", + "StatusMessage": "Created Profile Association" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/get-profile-resource-association.rst b/awscli/examples/route53profiles/get-profile-resource-association.rst new file mode 100644 index 000000000000..53603493ba0e --- /dev/null +++ b/awscli/examples/route53profiles/get-profile-resource-association.rst @@ -0,0 +1,24 @@ +**To get information about a resource associated to a Profile** + +The following ``get-profile-resource-association`` returns information about the specified resource association to a Profile. :: + + aws route53profiles get-profile-resource-association \ + --profile-resource-association-id rpr-001913120a7example + +Output:: + + { + "ProfileResourceAssociation": { + "CreationTime": 1710851216.613, + "Id": "rpr-001913120a7example", + "ModificationTime": 1710852303.798, + "Name": "test-resource-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceArn": "arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example", + "ResourceProperties": "{\"priority\":105}", + "ResourceType": "FIREWALL_RULE_GROUP", + "Status": "COMPLETE", + "StatusMessage": "Completed creation of Profile to DNS Firewall rule group association" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/get-profile.rst b/awscli/examples/route53profiles/get-profile.rst new file mode 100644 index 000000000000..5e99d0c3db3d --- /dev/null +++ b/awscli/examples/route53profiles/get-profile.rst @@ -0,0 +1,23 @@ +**To get information about a Profile** + +The following ``get-profile`` returns information about the specified Profile. :: + + aws route53profiles get-profile \ + --profile-id rp-4987774726example + +Output:: + + { + "Profile": { + "Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-4987774726example", + "ClientToken": "0cbc5ae7-4921-4204-bea9-EXAMPLE11111", + "CreationTime": 1710851044.288, + "Id": "rp-4987774726example", + "ModificationTime": 1710851044.288, + "Name": "test", + "OwnerId": "123456789012", + "ShareStatus": "NOT_SHARED", + "Status": "COMPLETE", + "StatusMessage": "Created Profile" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/list-profile-associations.rst b/awscli/examples/route53profiles/list-profile-associations.rst new file mode 100644 index 000000000000..49ab92e31fac --- /dev/null +++ b/awscli/examples/route53profiles/list-profile-associations.rst @@ -0,0 +1,23 @@ +**To list Profile associations** + +The following ``list-profile-associations`` lists the Profile associations in your AWS account. :: + + aws route53profiles list-profile-associations + +Output:: + + { + "ProfileAssociations": [ + { + "CreationTime": 1709338817.148, + "Id": "rpassoc-489ce212fexample", + "ModificationTime": 1709338974.772, + "Name": "test-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceId": "vpc-0af3b96b3example", + "Status": "COMPLETE", + "StatusMessage": "Created Profile Association" + } + ] + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/list-profile-resource-associations.rst b/awscli/examples/route53profiles/list-profile-resource-associations.rst new file mode 100644 index 000000000000..24b6a1fc3045 --- /dev/null +++ b/awscli/examples/route53profiles/list-profile-resource-associations.rst @@ -0,0 +1,26 @@ +**To list Profile resource associations** + +The following ``list-profile-resource-associations`` list the Profile resource associations for the specified Profile. :: + + aws route53profiles list-profile-resource-associations \ + --profile-id rp-4987774726example + +Output:: + + { + "ProfileResourceAssociations": [ + { + "CreationTime": 1710851216.613, + "Id": "rpr-001913120a7example", + "ModificationTime": 1710851216.613, + "Name": "test-resource-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceArn": "arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example", + "ResourceProperties": "{\"priority\":102}", + "ResourceType": "FIREWALL_RULE_GROUP", + "Status": "COMPLETE", + "StatusMessage": "Completed creation of Profile to DNS Firewall rule group association" + } + ] + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/list-profiles.rst b/awscli/examples/route53profiles/list-profiles.rst new file mode 100644 index 000000000000..4abcc8b8bba5 --- /dev/null +++ b/awscli/examples/route53profiles/list-profiles.rst @@ -0,0 +1,18 @@ +**To list Profiles** + +The following ``list-profiles`` lists the Profiles in your AWS account and displays additional information about them. :: + + aws route53profiles list-profiles + +Output:: + + { + "ProfileSummaries": [ + { + "Arn": "arn:aws:route53profiles:us-east-1:123456789012:profile/rp-4987774726example", + "Id": "rp-4987774726example", + "Name": "test", + "ShareStatus": "NOT_SHARED" + } + ] + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/list-tags-for-resource.rst b/awscli/examples/route53profiles/list-tags-for-resource.rst new file mode 100644 index 000000000000..852751d716dc --- /dev/null +++ b/awscli/examples/route53profiles/list-tags-for-resource.rst @@ -0,0 +1,15 @@ +**To list tags for a resource** + +The following ``list-tags-for-resource`` lists tags for the specified resource. :: + + aws route53profiles list-tags-for-resource \ + --resource-arn arn:aws:route53profiles:us-east-1:123456789012:profile/rp-4987774726example + +Output:: + + { + "Tags": { + "my-key-2": "my-value-2", + "my-key-1": "my-value-1" + } + } \ No newline at end of file diff --git a/awscli/examples/route53profiles/update-profile-resource-association.rst b/awscli/examples/route53profiles/update-profile-resource-association.rst new file mode 100644 index 000000000000..2f05e7520472 --- /dev/null +++ b/awscli/examples/route53profiles/update-profile-resource-association.rst @@ -0,0 +1,25 @@ +**To update a resource associated to a Profile** + +The following ``update-profile-resource-association`` updates a priority of a DNS Firewall rule group that is associated to the Profile. :: + + aws route53profiles update-profile-resource-association \ + --profile-resource-association-id rpr-001913120a7example \ + --resource-properties "{\"priority\": 105}" + +Output:: + + { + "ProfileResourceAssociation": { + "CreationTime": 1710851216.613, + "Id": "rpr-001913120a7example", + "ModificationTime": 1710852303.798, + "Name": "test-resource-association", + "OwnerId": "123456789012", + "ProfileId": "rp-4987774726example", + "ResourceArn": "arn:aws:route53resolver:us-east-1:123456789012:firewall-rule-group/rslvr-frg-cfe7f72example", + "ResourceProperties": "{\"priority\":105}", + "ResourceType": "FIREWALL_RULE_GROUP", + "Status": "UPDATING", + "StatusMessage": "Updating the Profile to DNS Firewall rule group association" + } + } \ No newline at end of file