cluster

Documentation

Index

• type Endpoint
  • func (strct *Endpoint) MarshalJSON() ([]byte, error)
  • func (strct *Endpoint) UnmarshalJSON(b []byte) error
• type LoggingProperties
  • func (strct *LoggingProperties) MarshalJSON() ([]byte, error)
  • func (strct *LoggingProperties) UnmarshalJSON(b []byte) error
• type Resource
  • func (strct *Resource) MarshalJSON() ([]byte, error)
  • func (strct *Resource) UnmarshalJSON(b []byte) error
• type Tag
  • func (strct *Tag) MarshalJSON() ([]byte, error)
  • func (strct *Tag) UnmarshalJSON(b []byte) error

Types

type Endpoint

type Endpoint struct {
	Address string `json:"Address,omitempty"`
	Port    string `json:"Port,omitempty"`
}

Endpoint

func (*Endpoint) MarshalJSON

func (strct *Endpoint) MarshalJSON() ([]byte, error)

func (*Endpoint) UnmarshalJSON

func (strct *Endpoint) UnmarshalJSON(b []byte) error

type LoggingProperties

type LoggingProperties struct {
	BucketName  string `json:"BucketName"`
	S3KeyPrefix string `json:"S3KeyPrefix,omitempty"`
}

LoggingProperties

func (*LoggingProperties) MarshalJSON

func (strct *LoggingProperties) MarshalJSON() ([]byte, error)

func (*LoggingProperties) UnmarshalJSON

func (strct *LoggingProperties) UnmarshalJSON(b []byte) error

type Resource

type Resource struct {

	// Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
	AllowVersionUpgrade bool `json:"AllowVersionUpgrade,omitempty"`

	// The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
	//
	// enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
	// disabled - Don't use AQUA.
	// auto - Amazon Redshift determines whether to use AQUA.
	//
	AquaConfigurationStatus string `json:"AquaConfigurationStatus,omitempty"`

	// The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
	AutomatedSnapshotRetentionPeriod int `json:"AutomatedSnapshotRetentionPeriod,omitempty"`

	// The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
	AvailabilityZone string `json:"AvailabilityZone,omitempty"`

	// The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
	AvailabilityZoneRelocation bool `json:"AvailabilityZoneRelocation,omitempty"`

	// The availability zone relocation status of the cluster
	AvailabilityZoneRelocationStatus string `json:"AvailabilityZoneRelocationStatus,omitempty"`

	// A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
	Classic bool `json:"Classic,omitempty"`

	// 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. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
	ClusterIdentifier string `json:"ClusterIdentifier,omitempty"`

	// The name of the parameter group to be associated with this cluster.
	ClusterParameterGroupName string `json:"ClusterParameterGroupName,omitempty"`

	// A list of security groups to be associated with this cluster.
	ClusterSecurityGroups []string `json:"ClusterSecurityGroups,omitempty"`

	// The name of a cluster subnet group to be associated with this cluster.
	ClusterSubnetGroupName string `json:"ClusterSubnetGroupName,omitempty"`

	// The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
	ClusterType string `json:"ClusterType"`

	// 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.
	ClusterVersion string `json:"ClusterVersion,omitempty"`

	// 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.
	DBName string `json:"DBName"`

	// A boolean indicating whether to enable the deferred maintenance window.
	DeferMaintenance bool `json:"DeferMaintenance,omitempty"`

	// An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
	DeferMaintenanceDuration int `json:"DeferMaintenanceDuration,omitempty"`

	// A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
	DeferMaintenanceEndTime string `json:"DeferMaintenanceEndTime,omitempty"`

	// A unique identifier for the deferred maintenance window.
	DeferMaintenanceIdentifier string `json:"DeferMaintenanceIdentifier,omitempty"`

	// A timestamp indicating the start time for the deferred maintenance window.
	DeferMaintenanceStartTime string `json:"DeferMaintenanceStartTime,omitempty"`

	// The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
	DestinationRegion string `json:"DestinationRegion,omitempty"`

	// The Elastic IP (EIP) address for the cluster.
	ElasticIp string `json:"ElasticIp,omitempty"`

	// If true, the data in the cluster is encrypted at rest.
	Encrypted bool      `json:"Encrypted,omitempty"`
	Endpoint  *Endpoint `json:"Endpoint,omitempty"`

	// 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 in the Amazon Redshift Cluster Management Guide.
	//
	// If this option is true , enhanced VPC routing is enabled.
	//
	// Default: false
	EnhancedVpcRouting bool `json:"EnhancedVpcRouting,omitempty"`

	// Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
	HsmClientCertificateIdentifier string `json:"HsmClientCertificateIdentifier,omitempty"`

	// 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.
	HsmConfigurationIdentifier string `json:"HsmConfigurationIdentifier,omitempty"`

	// A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
	IamRoles []string `json:"IamRoles,omitempty"`
	Id       string   `json:"Id,omitempty"`

	// The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
	KmsKeyId          string             `json:"KmsKeyId,omitempty"`
	LoggingProperties *LoggingProperties `json:"LoggingProperties,omitempty"`

	// The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
	MaintenanceTrackName string `json:"MaintenanceTrackName,omitempty"`

	// The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
	//
	// The value must be either -1 or an integer between 1 and 3,653.
	ManualSnapshotRetentionPeriod int `json:"ManualSnapshotRetentionPeriod,omitempty"`

	// The password associated with the master user account for the cluster that is being created. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
	MasterUserPassword string `json:"MasterUserPassword"`

	// The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
	MasterUsername string `json:"MasterUsername"`

	// The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
	NodeType string `json:"NodeType"`

	// The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
	NumberOfNodes int    `json:"NumberOfNodes,omitempty"`
	OwnerAccount  string `json:"OwnerAccount,omitempty"`

	// The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
	Port int `json:"Port,omitempty"`

	// The weekly time range (in UTC) during which automated cluster maintenance can occur.
	PreferredMaintenanceWindow string `json:"PreferredMaintenanceWindow,omitempty"`

	// If true, the cluster can be accessed from a public network.
	PubliclyAccessible bool `json:"PubliclyAccessible,omitempty"`

	// The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster APIs
	ResourceAction string `json:"ResourceAction,omitempty"`

	// The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
	RevisionTarget string `json:"RevisionTarget,omitempty"`

	// A boolean indicating if we want to rotate Encryption Keys.
	RotateEncryptionKey bool `json:"RotateEncryptionKey,omitempty"`

	// The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
	SnapshotClusterIdentifier string `json:"SnapshotClusterIdentifier,omitempty"`

	// The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
	SnapshotCopyGrantName string `json:"SnapshotCopyGrantName,omitempty"`

	// Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
	SnapshotCopyManual bool `json:"SnapshotCopyManual,omitempty"`

	// The number of days to retain automated snapshots in the destination region after they are copied from the source region.
	//
	//  Default is 7.
	//
	//  Constraints: Must be at least 1 and no more than 35.
	SnapshotCopyRetentionPeriod int `json:"SnapshotCopyRetentionPeriod,omitempty"`

	// The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
	SnapshotIdentifier string `json:"SnapshotIdentifier,omitempty"`

	// The list of tags for the cluster parameter group.
	Tags []*Tag `json:"Tags,omitempty"`

	// A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
	VpcSecurityGroupIds []string `json:"VpcSecurityGroupIds,omitempty"`
}

Resource An example resource schema demonstrating some basic constructs and validation rules.

func (*Resource) MarshalJSON

func (strct *Resource) MarshalJSON() ([]byte, error)

func (*Resource) UnmarshalJSON

func (strct *Resource) UnmarshalJSON(b []byte) error

type Tag

type Tag struct {

	// The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Key string `json:"Key"`

	// The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
	Value string `json:"Value"`
}

Tag A key-value pair to associate with a resource.

func (*Tag) MarshalJSON

func (strct *Tag) MarshalJSON() ([]byte, error)

func (*Tag) UnmarshalJSON

func (strct *Tag) UnmarshalJSON(b []byte) error