AWS redshift: Reformat Redshift modify-cluster CLI examples and add outputs
Summary
Restructures the modify-cluster examples into numbered examples (associate security group, modify maintenance window, change master password) and adds sample JSON outputs.
Security assessment
The change is a documentation formatting/example refresh. It includes a master password example but only demonstrates the existing CLI parameter; no new security guidance, vulnerability fix, or credential-handling change is introduced.
Evidence
--master-user-password A1b2c3d4
Diff
diff --git a/redshift/latest/mgmt/example_redshift_ModifyCluster_section.md b/redshift/latest/mgmt/example_redshift_ModifyCluster_section.md index 5384a53..6671939 100644 --- a//redshift/latest/mgmt/example_redshift_ModifyCluster_section.md +++ b//redshift/latest/mgmt/example_redshift_ModifyCluster_section.md @@ -76 +76 @@ CLI -Associate a Security Group with a ClusterThis example shows how to associate a cluster security group with the specified cluster.Command: +**Example 1: To associate a security group with a cluster** @@ -77,0 +78 @@ Associate a Security Group with a ClusterThis example shows how to associate a c +The following `modify-cluster` example associates a cluster security group with the specified cluster. @@ -79 +79,0 @@ Associate a Security Group with a ClusterThis example shows how to associate a c - aws redshift modify-cluster --cluster-identifier mycluster --cluster-security-groups mysecuritygroup @@ -81 +81,3 @@ Associate a Security Group with a ClusterThis example shows how to associate a c -Modify the Maintenance Window for a ClusterThis shows how to change the weekly preferred maintenance window for a cluster to be the minimum four hour window starting Sundays at 11:15 PM, and ending Mondays at 3:15 AM.Command: + aws redshift modify-cluster \ + --cluster-identifier mycluster \ + --cluster-security-groups mysecuritygroup @@ -84 +86 @@ Modify the Maintenance Window for a ClusterThis shows how to change the weekly p - aws redshift modify-cluster --cluster-identifier mycluster --preferred-maintenance-window Sun:23:15-Mon:03:15 +Output: @@ -86 +87,0 @@ Modify the Maintenance Window for a ClusterThis shows how to change the weekly p -Change the Master Password for the ClusterThis example shows how to change the master password for a cluster.Command: @@ -87,0 +89,164 @@ Change the Master Password for the ClusterThis example shows how to change the m + { + "Cluster": { + "ClusterIdentifier": "mycluster", + "NodeType": "dc2.large", + "ClusterStatus": "available", + "ClusterAvailabilityStatus": "Available", + "MasterUsername": "adminuser", + "DBName": "dev", + "Endpoint": { + "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", + "Port": 5439 + }, + "ClusterCreateTime": "2019-12-02T22:45:07.890Z", + "AutomatedSnapshotRetentionPeriod": 1, + "ManualSnapshotRetentionPeriod": -1, + "ClusterSecurityGroups": [ + { + "ClusterSecurityGroupName": "default", + "Status": "removing" + }, + { + "ClusterSecurityGroupName": "mysecuritygroup", + "Status": "adding" + } + ], + "VpcSecurityGroups": [], + "ClusterParameterGroups": [ + { + "ParameterGroupName": "default.redshift-1.0", + "ParameterApplyStatus": "in-sync" + } + ], + "AvailabilityZone": "us-west-2a", + "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", + "PendingModifiedValues": {}, + "ClusterVersion": "1.0", + "AllowVersionUpgrade": true, + "NumberOfNodes": 2, + "PubliclyAccessible": true, + "Encrypted": false, + "Tags": [], + "EnhancedVpcRouting": false, + "IamRoles": [], + "MaintenanceTrackName": "current" + } + } + +For more information, see [Modifying a cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/modify-cluster.html) in the _Amazon Redshift Management Guide_. + +**Example 2: To modify the maintenance window for a cluster** + +The following `modify-cluster` example changes the weekly preferred maintenance window for a cluster to be the minimum four hour window starting Sundays at 11:15 PM, and ending Mondays at 3:15 AM. + + + aws redshift modify-cluster \ + --cluster-identifier mycluster \ + --preferred-maintenance-window Sun:23:15-Mon:03:15 + + +Output: + + + { + "Cluster": { + "ClusterIdentifier": "mycluster", + "NodeType": "dc2.large", + "ClusterStatus": "available", + "ClusterAvailabilityStatus": "Available", + "MasterUsername": "adminuser", + "DBName": "dev", + "Endpoint": { + "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", + "Port": 5439 + }, + "ClusterCreateTime": "2019-12-02T22:45:07.890Z", + "AutomatedSnapshotRetentionPeriod": 1, + "ManualSnapshotRetentionPeriod": -1, + "ClusterSecurityGroups": [ + { + "ClusterSecurityGroupName": "default", + "Status": "active" + } + ], + "VpcSecurityGroups": [], + "ClusterParameterGroups": [ + { + "ParameterGroupName": "default.redshift-1.0", + "ParameterApplyStatus": "in-sync" + } + ], + "AvailabilityZone": "us-west-2a", + "PreferredMaintenanceWindow": "sun:23:15-mon:03:15", + "PendingModifiedValues": {}, + "ClusterVersion": "1.0", + "AllowVersionUpgrade": true, + "NumberOfNodes": 2, + "PubliclyAccessible": true, + "Encrypted": false, + "Tags": [], + "EnhancedVpcRouting": false, + "IamRoles": [], + "MaintenanceTrackName": "current" + } + } + +For more information, see [Maintenance windows](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-considerations.html#rs-maintenance-windows) in the _Amazon Redshift Management Guide_. + +**Example 3: To change the master password for the cluster** + +The following `modify-cluster` example changes the master password for a cluster. + + + aws redshift modify-cluster \ + --cluster-identifier mycluster \ + --master-user-password A1b2c3d4 + + +Output: + + + { + "Cluster": { + "ClusterIdentifier": "mycluster", + "NodeType": "dc2.large", + "ClusterStatus": "available", + "ClusterAvailabilityStatus": "Available", + "MasterUsername": "adminuser", + "DBName": "dev", + "Endpoint": { + "Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com", + "Port": 5439 + }, + "ClusterCreateTime": "2019-12-02T22:45:07.890Z", + "AutomatedSnapshotRetentionPeriod": 1, + "ManualSnapshotRetentionPeriod": -1, + "ClusterSecurityGroups": [ + { + "ClusterSecurityGroupName": "default", + "Status": "active" + } + ], + "VpcSecurityGroups": [], + "ClusterParameterGroups": [ + { + "ParameterGroupName": "default.redshift-1.0", + "ParameterApplyStatus": "in-sync" + } + ], + "AvailabilityZone": "us-west-2a", + "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", + "PendingModifiedValues": { + "MasterUserPassword": "****" + }, + "ClusterVersion": "1.0", + "AllowVersionUpgrade": true, + "NumberOfNodes": 2, + "PubliclyAccessible": true, + "Encrypted": false, + "Tags": [], + "EnhancedVpcRouting": false, + "IamRoles": [], + "MaintenanceTrackName": "current" + } + } @@ -89 +254 @@ Change the Master Password for the ClusterThis example shows how to change the m - aws redshift modify-cluster --cluster-identifier mycluster --master-user-password A1b2c3d4 +For more information, see [Modifying a cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/modify-cluster.html) in the _Amazon Redshift Management Guide_.