awscc.redshift_cluster

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - redshift:DescribeClusters, redshift:DeleteCluster

update

Parent base class for filters and actions.

definitions:
  Endpoint:
    properties:
      Address:
        type: string
      Port:
        type: string
    type: object
  LoggingProperties:
    additionalProperties: false
    properties:
      BucketName:
        type: string
      S3KeyPrefix:
        type: string
    required:
    - BucketName
    type: object
  Tag:
    additionalProperties: false
    description: A key-value pair to associate with a resource.
    properties:
      Key:
        description: '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 -.'
        maxLength: 127
        minLength: 1
        type: string
      Value:
        description: '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 -.'
        maxLength: 255
        minLength: 1
        type: string
    required:
    - Value
    - Key
    type: object
properties:
  AllowVersionUpgrade:
    description: 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
    type: boolean
  AquaConfigurationStatus:
    description: '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.

      '
    type: string
  AutomatedSnapshotRetentionPeriod:
    description: The number of days that automated snapshots are retained. If the
      value is 0, automated snapshots are disabled. Default value is 1
    type: integer
  AvailabilityZone:
    description: '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'
    type: string
  AvailabilityZoneRelocation:
    description: The option to enable relocation for an Amazon Redshift cluster between
      Availability Zones after the cluster modification is complete.
    type: boolean
  AvailabilityZoneRelocationStatus:
    description: The availability zone relocation status of the cluster
    type: string
  Classic:
    description: 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.
    type: boolean
  ClusterParameterGroupName:
    description: The name of the parameter group to be associated with this cluster.
    maxLength: 255
    type: string
  ClusterSecurityGroups:
    description: A list of security groups to be associated with this cluster.
    items:
      type: string
    type: array
    uniqueItems: false
  ClusterType:
    description: 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
    type: string
  ClusterVersion:
    description: 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.
    type: string
  DeferMaintenance:
    description: A boolean indicating whether to enable the deferred maintenance window.
    type: boolean
  DeferMaintenanceDuration:
    description: 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.
    type: integer
  DeferMaintenanceEndTime:
    description: A timestamp indicating end time for the deferred maintenance window.
      If you specify an end time, you can't specify a duration.
    type: string
  DeferMaintenanceStartTime:
    description: A timestamp indicating the start time for the deferred maintenance
      window.
    type: string
  DestinationRegion:
    description: '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'
    type: string
  ElasticIp:
    description: The Elastic IP (EIP) address for the cluster.
    type: string
  Encrypted:
    description: If true, the data in the cluster is encrypted at rest.
    type: boolean
  Endpoint:
    properties:
      Address:
        type: string
      Port:
        type: string
    type: object
  EnhancedVpcRouting:
    description: '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'
    type: boolean
  HsmClientCertificateIdentifier:
    description: Specifies the name of the HSM client certificate the Amazon Redshift
      cluster uses to retrieve the data encryption keys stored in an HSM
    type: string
  HsmConfigurationIdentifier:
    description: 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.
    type: string
  IamRoles:
    description: 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 10 IAM
      roles in a single request
    items:
      type: string
    maxItems: 10
    type: array
    uniqueItems: true
  KmsKeyId:
    description: The AWS Key Management Service (KMS) key ID of the encryption key
      that you want to use to encrypt data in the cluster.
    type: string
  LoggingProperties:
    additionalProperties: false
    properties:
      BucketName:
        type: string
      S3KeyPrefix:
        type: string
    required:
    - BucketName
    type: object
  MaintenanceTrackName:
    description: 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.
    type: string
  ManualSnapshotRetentionPeriod:
    description: '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.'
    type: integer
  MasterUserPassword:
    description: 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.
    maxLength: 64
    type: string
  NodeType:
    description: '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'
    type: string
  NumberOfNodes:
    description: The number of compute nodes in the cluster. This parameter is required
      when the ClusterType parameter is specified as multi-node.
    type: integer
  PreferredMaintenanceWindow:
    description: The weekly time range (in UTC) during which automated cluster maintenance
      can occur.
    type: string
  PubliclyAccessible:
    description: If true, the cluster can be accessed from a public network.
    type: boolean
  ResourceAction:
    description: The Redshift operation to be performed. Resource Action supports
      pause-cluster, resume-cluster APIs
    type: string
  RevisionTarget:
    description: The identifier of the database revision. You can retrieve this value
      from the response to the DescribeClusterDbRevisions request.
    type: string
  RotateEncryptionKey:
    description: A boolean indicating if we want to rotate Encryption Keys.
    type: boolean
  SnapshotCopyGrantName:
    description: The name of the snapshot copy grant to use when snapshots of an AWS
      KMS-encrypted cluster are copied to the destination region.
    type: string
  SnapshotCopyManual:
    description: Indicates whether to apply the snapshot retention period to newly
      copied manual snapshots instead of automated snapshots.
    type: boolean
  SnapshotCopyRetentionPeriod:
    description: "The number of days to retain automated snapshots in the destination\
      \ region after they are copied from the source region. \n\n Default is 7. \n\
      \n Constraints: Must be at least 1 and no more than 35."
    type: integer
  Tags:
    description: The list of tags for the cluster parameter group.
    items:
      additionalProperties: false
      description: A key-value pair to associate with a resource.
      properties:
        Key:
          description: '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 -.'
          maxLength: 127
          minLength: 1
          type: string
        Value:
          description: '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 -.'
          maxLength: 255
          minLength: 1
          type: string
      required:
      - Value
      - Key
      type: object
    maxItems: 50
    type: array
    uniqueItems: false
  VpcSecurityGroupIds:
    description: A list of Virtual Private Cloud (VPC) security groups to be associated
      with the cluster.
    items:
      type: string
    type: array
    uniqueItems: false
  type:
    enum:
    - update

Permissions - redshift:DescribeClusters, redshift:ModifyCluster, redshift:ModifyClusterIamRoles, redshift:EnableLogging, redshift:CreateTags, redshift:DeleteTags, redshift:DisableLogging, redshift:RebootCluster, redshift:EnableSnapshotCopy, redshift:DisableSnapshotCopy, redshift:ModifySnapshotCopyRetentionPeriod, redshift:ModifyAquaConfiguration, redshift:ResizeCluster, redshift:ModifyClusterMaintenance, redshift:DescribeClusterDbRevisions, redshift:ModifyClusterDbRevisions, redshift:PauseCluster, redshift:ResumeCluster, redshift:RotateEncryptionKey