IParameterGroup Interface
A parameter group.
Represents both a cluster parameter group, and an instance parameter group.
Properties
dbClusterParameterGroupRefDBClusterParameterGroupReferencedb_cluster_parameter_group_refDBClusterParameterGroupReferencedbClusterParameterGroupRefDBClusterParameterGroupReferenceDbClusterParameterGroupRefDBClusterParameterGroupReferenceDbClusterParameterGroupRefDBClusterParameterGroupReferencerequired#dbParameterGroupRefDBParameterGroupReferencedb_parameter_group_refDBParameterGroupReferencedbParameterGroupRefDBParameterGroupReferenceDbParameterGroupRefDBParameterGroupReferenceDbParameterGroupRefDBParameterGroupReferencerequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
Methods
addParameter(key: string, value: string): booleandef add_parameter(self, key: str, value: str) -> boolpublic Boolean addParameter(String key, String value)public bool AddParameter(string key, string value)func AddParameter(Key *string, Value *string) *bool#If this is an imported parameter group, this method does nothing.
returns
Returns: true if the parameter was actually added (i.e., this ParameterGroup is not imported), false otherwise
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
bindToCluster(options: ParameterGroupClusterBindOptions): ParameterGroupClusterConfigdef bind_to_cluster(self, options: ParameterGroupClusterBindOptions) -> ParameterGroupClusterConfigpublic ParameterGroupClusterConfig bindToCluster(ParameterGroupClusterBindOptions options)public ParameterGroupClusterConfig BindToCluster(ParameterGroupClusterBindOptions options)func BindToCluster(Options ParameterGroupClusterBindOptions) ParameterGroupClusterConfig#bindToInstance(options: ParameterGroupInstanceBindOptions): ParameterGroupInstanceConfigdef bind_to_instance(self, options: ParameterGroupInstanceBindOptions) -> ParameterGroupInstanceConfigpublic ParameterGroupInstanceConfig bindToInstance(ParameterGroupInstanceBindOptions options)public ParameterGroupInstanceConfig BindToInstance(ParameterGroupInstanceBindOptions options)func BindToInstance(Options ParameterGroupInstanceBindOptions) ParameterGroupInstanceConfig#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining