Class: Aws::Redshift::Types::CreateClusterMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-redshift/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:master_user_password]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_infoString

Reserved.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#allow_version_upgradeBoolean

If ‘true`, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: ‘true`

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#aqua_configuration_statusString

This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#automated_snapshot_retention_periodInteger

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

You can’t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: ‘1`

Constraints: Must be a value from 0 to 35.

Returns:

  • (Integer)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#availability_zoneString

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: ‘us-east-2d`

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#availability_zone_relocationBoolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#cluster_identifierString

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an Amazon Web Services account.

Example: ‘myexamplecluster`

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#cluster_parameter_group_nameString

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to [Working with Amazon Redshift Parameter Groups]

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#cluster_security_groupsArray<String>

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Returns:

  • (Array<String>)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#cluster_subnet_group_nameString

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#cluster_typeString

The type of the cluster. When cluster type is specified as

  • ‘single-node`, the NumberOfNodes parameter is not required.

  • ‘multi-node`, the NumberOfNodes parameter is required.

Valid Values: ‘multi-node` | `single-node`

Default: ‘multi-node`

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#cluster_versionString

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: ‘1.0`

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#db_nameString

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to [Create a Database] in the Amazon Redshift Database Developer Guide.

Default: ‘dev`

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in [Reserved Words] in the Amazon Redshift Database Developer Guide.

[1]: docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html [2]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#default_iam_role_arnString

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#elastic_ipString

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don’t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to [Supported Platforms to Launch Your Cluster] in the Amazon Redshift Cluster Management Guide.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#encryptedBoolean

If ‘true`, the data in the cluster is encrypted at rest.

Default: false

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#enhanced_vpc_routingBoolean

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see

Enhanced VPC Routing][1

in the Amazon Redshift Cluster Management

Guide.

If this option is ‘true`, enhanced VPC routing is enabled.

Default: false

[1]: docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#hsm_client_certificate_identifierString

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#hsm_configuration_identifierString

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#iam_rolesArray<String>

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to [Quotas and limits] in the *Amazon Redshift Cluster Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html

Returns:

  • (Array<String>)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#ip_address_typeString

The IP address types that the cluster supports. Possible values are ‘ipv4` and `dualstack`.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#kms_key_idString

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#load_sample_dataString

A flag that specifies whether to load sample data once the cluster is created.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#maintenance_track_nameString

An optional parameter for the name of the maintenance track for the cluster. If you don’t provide a maintenance track name, the cluster is assigned to the ‘current` track.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#manage_master_passwordBoolean

If ‘true`, Amazon Redshift uses Secrets Manager to manage this cluster’s admin credentials. You can’t use ‘MasterUserPassword` if `ManageMasterPassword` is true. If `ManageMasterPassword` is false or not set, Amazon Redshift uses `MasterUserPassword` for the admin user account’s password.

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#manual_snapshot_retention_periodInteger

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn’t change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

Returns:

  • (Integer)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_password_secret_kms_key_idString

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret. You can only use this parameter if ‘ManageMasterPassword` is true.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_user_passwordString

The password associated with the admin user account for the cluster that is being created.

You can’t use ‘MasterUserPassword` if `ManageMasterPassword` is `true`.

Constraints:

  • Must be between 8 and 64 characters in length.

  • Must contain at least one uppercase letter.

  • Must contain at least one lowercase letter.

  • Must contain one number.

  • Can be any printable ASCII character (ASCII code 33-126) except ‘’‘ (single quote), `“` (double quote), “, `/`, or `@`.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_usernameString

The user name associated with the admin user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters or hyphens. The user name can’t be ‘PUBLIC`.

  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • The first character must be a letter.

  • Must not contain a colon (:) or a slash (/).

  • Cannot be a reserved word. A list of reserved words can be found in [Reserved Words] in the Amazon Redshift Database Developer Guide.

[1]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#multi_azBoolean

If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#node_typeString

The node type to be provisioned for the cluster. For information about node types, go to [ Working with Clusters] in the *Amazon Redshift Cluster Management Guide*.

Valid Values: ‘dc2.large` | `dc2.8xlarge` | `ra3.xlplus` | `ra3.4xlarge` | `ra3.16xlarge`

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#number_of_nodesInteger

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as ‘multi-node`.

For information about determining how many nodes you need, go to [ Working with Clusters] in the *Amazon Redshift Cluster Management Guide*.

If you don’t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: ‘1`

Constraints: Value must be at least 1 and no more than 100.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes

Returns:

  • (Integer)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#portInteger

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: ‘5439`

Valid Values:

  • For clusters with ra3 nodes - Select a port within the ranges ‘5431-5455` or `8191-8215`. (If you have an existing cluster with ra3 nodes, it isn’t required that you change the port to these ranges.)

  • For clusters with dc2 nodes - Select a port within the range ‘1150-65535`.

Returns:

  • (Integer)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#preferred_maintenance_windowString

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ‘ddd:hh24:mi-ddd:hh24:mi`

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see [Maintenance Windows] in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#publicly_accessibleBoolean

If ‘true`, the cluster can be accessed from a public network.

Returns:

  • (Boolean)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#redshift_idc_application_arnString

The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#snapshot_schedule_identifierString

A unique identifier for the snapshot schedule.

Returns:

  • (String)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tag instances.

Returns:



2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Returns:

  • (Array<String>)


2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/aws-sdk-redshift/types.rb', line 2340

class CreateClusterMessage < Struct.new(
  :db_name,
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :master_username,
  :master_user_password,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :cluster_subnet_group_name,
  :availability_zone,
  :preferred_maintenance_window,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :manual_snapshot_retention_period,
  :port,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :elastic_ip,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :additional_info,
  :iam_roles,
  :maintenance_track_name,
  :snapshot_schedule_identifier,
  :availability_zone_relocation,
  :aqua_configuration_status,
  :default_iam_role_arn,
  :load_sample_data,
  :manage_master_password,
  :master_password_secret_kms_key_id,
  :ip_address_type,
  :multi_az,
  :redshift_idc_application_arn)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end