73 lines
2.1 KiB
TypeScript
73 lines
2.1 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { IResource } from '../../core';
|
|
import { Resource } from '../../core';
|
|
import type { IDBClusterParameterGroupRef, DBClusterParameterGroupReference } from '../../interfaces/generated/aws-docdb-interfaces.generated';
|
|
/**
|
|
* A parameter group
|
|
*/
|
|
export interface IClusterParameterGroup extends IResource, IDBClusterParameterGroupRef {
|
|
/**
|
|
* The name of this parameter group
|
|
*/
|
|
readonly parameterGroupName: string;
|
|
}
|
|
/**
|
|
* A new cluster or instance parameter group
|
|
*/
|
|
declare abstract class ClusterParameterGroupBase extends Resource implements IClusterParameterGroup {
|
|
/**
|
|
* Imports a parameter group
|
|
*/
|
|
static fromParameterGroupName(scope: Construct, id: string, parameterGroupName: string): IClusterParameterGroup;
|
|
/**
|
|
* The name of the parameter group
|
|
*/
|
|
abstract readonly parameterGroupName: string;
|
|
/**
|
|
* A reference to this parameter group.
|
|
*/
|
|
get dbClusterParameterGroupRef(): DBClusterParameterGroupReference;
|
|
}
|
|
/**
|
|
* Properties for a cluster parameter group
|
|
*/
|
|
export interface ClusterParameterGroupProps {
|
|
/**
|
|
* Description for this parameter group
|
|
*
|
|
* @default a CDK generated description
|
|
*/
|
|
readonly description?: string;
|
|
/**
|
|
* Database family of this parameter group
|
|
*/
|
|
readonly family: string;
|
|
/**
|
|
* The name of the cluster parameter group
|
|
*
|
|
* @default A CDK generated name for the cluster parameter group
|
|
*/
|
|
readonly dbClusterParameterGroupName?: string;
|
|
/**
|
|
* The parameters in this parameter group
|
|
*/
|
|
readonly parameters: {
|
|
[key: string]: string;
|
|
};
|
|
}
|
|
/**
|
|
* A cluster parameter group
|
|
*
|
|
* @resource AWS::DocDB::DBClusterParameterGroup
|
|
*/
|
|
export declare class ClusterParameterGroup extends ClusterParameterGroupBase implements IClusterParameterGroup {
|
|
/** Uniquely identifies this class. */
|
|
static readonly PROPERTY_INJECTION_ID: string;
|
|
/**
|
|
* The name of the parameter group
|
|
*/
|
|
readonly parameterGroupName: string;
|
|
constructor(scope: Construct, id: string, props: ClusterParameterGroupProps);
|
|
}
|
|
export {};
|