Documentation
¶
Index ¶
- func CfnBatchScramSecret_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBatchScramSecret_IsCfnElement(x interface{}) *bool
- func CfnBatchScramSecret_IsCfnResource(x interface{}) *bool
- func CfnBatchScramSecret_IsConstruct(x interface{}) *bool
- func CfnClusterPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClusterPolicy_IsCfnElement(x interface{}) *bool
- func CfnClusterPolicy_IsCfnResource(x interface{}) *bool
- func CfnClusterPolicy_IsConstruct(x interface{}) *bool
- func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCluster_IsCfnElement(x interface{}) *bool
- func CfnCluster_IsCfnResource(x interface{}) *bool
- func CfnCluster_IsConstruct(x interface{}) *bool
- func CfnConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfiguration_IsCfnElement(x interface{}) *bool
- func CfnConfiguration_IsCfnResource(x interface{}) *bool
- func CfnConfiguration_IsConstruct(x interface{}) *bool
- func CfnReplicator_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicator_IsCfnElement(x interface{}) *bool
- func CfnReplicator_IsCfnResource(x interface{}) *bool
- func CfnReplicator_IsConstruct(x interface{}) *bool
- func CfnServerlessCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnServerlessCluster_IsCfnElement(x interface{}) *bool
- func CfnServerlessCluster_IsCfnResource(x interface{}) *bool
- func CfnServerlessCluster_IsConstruct(x interface{}) *bool
- func CfnVpcConnection_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVpcConnection_IsCfnElement(x interface{}) *bool
- func CfnVpcConnection_IsCfnResource(x interface{}) *bool
- func CfnVpcConnection_IsConstruct(x interface{}) *bool
- func NewCfnBatchScramSecret_Override(c CfnBatchScramSecret, scope constructs.Construct, id *string, ...)
- func NewCfnClusterPolicy_Override(c CfnClusterPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
- func NewCfnConfiguration_Override(c CfnConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnReplicator_Override(c CfnReplicator, scope constructs.Construct, id *string, ...)
- func NewCfnServerlessCluster_Override(c CfnServerlessCluster, scope constructs.Construct, id *string, ...)
- func NewCfnVpcConnection_Override(c CfnVpcConnection, scope constructs.Construct, id *string, ...)
- type CfnBatchScramSecret
- type CfnBatchScramSecretProps
- type CfnCluster
- type CfnClusterPolicy
- type CfnClusterPolicyProps
- type CfnClusterProps
- type CfnCluster_BrokerLogsProperty
- type CfnCluster_BrokerNodeGroupInfoProperty
- type CfnCluster_ClientAuthenticationProperty
- type CfnCluster_CloudWatchLogsProperty
- type CfnCluster_ConfigurationInfoProperty
- type CfnCluster_ConnectivityInfoProperty
- type CfnCluster_EBSStorageInfoProperty
- type CfnCluster_EncryptionAtRestProperty
- type CfnCluster_EncryptionInTransitProperty
- type CfnCluster_EncryptionInfoProperty
- type CfnCluster_FirehoseProperty
- type CfnCluster_IamProperty
- type CfnCluster_JmxExporterProperty
- type CfnCluster_LoggingInfoProperty
- type CfnCluster_NodeExporterProperty
- type CfnCluster_OpenMonitoringProperty
- type CfnCluster_PrometheusProperty
- type CfnCluster_ProvisionedThroughputProperty
- type CfnCluster_PublicAccessProperty
- type CfnCluster_S3Property
- type CfnCluster_SaslProperty
- type CfnCluster_ScramProperty
- type CfnCluster_StorageInfoProperty
- type CfnCluster_TlsProperty
- type CfnCluster_UnauthenticatedProperty
- type CfnCluster_VpcConnectivityClientAuthenticationProperty
- type CfnCluster_VpcConnectivityIamProperty
- type CfnCluster_VpcConnectivityProperty
- type CfnCluster_VpcConnectivitySaslProperty
- type CfnCluster_VpcConnectivityScramProperty
- type CfnCluster_VpcConnectivityTlsProperty
- type CfnConfiguration
- type CfnConfigurationProps
- type CfnConfiguration_LatestRevisionProperty
- type CfnReplicator
- type CfnReplicatorProps
- type CfnReplicator_AmazonMskClusterProperty
- type CfnReplicator_ConsumerGroupReplicationProperty
- type CfnReplicator_KafkaClusterClientVpcConfigProperty
- type CfnReplicator_KafkaClusterProperty
- type CfnReplicator_ReplicationInfoProperty
- type CfnReplicator_ReplicationStartingPositionProperty
- type CfnReplicator_ReplicationTopicNameConfigurationProperty
- type CfnReplicator_TopicReplicationProperty
- type CfnServerlessCluster
- type CfnServerlessClusterProps
- type CfnServerlessCluster_ClientAuthenticationProperty
- type CfnServerlessCluster_IamProperty
- type CfnServerlessCluster_SaslProperty
- type CfnServerlessCluster_VpcConfigProperty
- type CfnVpcConnection
- type CfnVpcConnectionProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnBatchScramSecret_CFN_RESOURCE_TYPE_NAME ¶ added in v2.16.0
func CfnBatchScramSecret_CFN_RESOURCE_TYPE_NAME() *string
func CfnBatchScramSecret_IsCfnElement ¶ added in v2.16.0
func CfnBatchScramSecret_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBatchScramSecret_IsCfnResource ¶ added in v2.16.0
func CfnBatchScramSecret_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBatchScramSecret_IsConstruct ¶ added in v2.16.0
func CfnBatchScramSecret_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnClusterPolicy_CFN_RESOURCE_TYPE_NAME ¶ added in v2.78.0
func CfnClusterPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnClusterPolicy_IsCfnElement ¶ added in v2.78.0
func CfnClusterPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnClusterPolicy_IsCfnResource ¶ added in v2.78.0
func CfnClusterPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnClusterPolicy_IsConstruct ¶ added in v2.78.0
func CfnClusterPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCluster_IsCfnElement ¶
func CfnCluster_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCluster_IsCfnResource ¶
func CfnCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCluster_IsConstruct ¶
func CfnCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnConfiguration_CFN_RESOURCE_TYPE_NAME ¶ added in v2.16.0
func CfnConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnConfiguration_IsCfnElement ¶ added in v2.16.0
func CfnConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConfiguration_IsCfnResource ¶ added in v2.16.0
func CfnConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnConfiguration_IsConstruct ¶ added in v2.16.0
func CfnConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnReplicator_CFN_RESOURCE_TYPE_NAME ¶ added in v2.103.0
func CfnReplicator_CFN_RESOURCE_TYPE_NAME() *string
func CfnReplicator_IsCfnElement ¶ added in v2.103.0
func CfnReplicator_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnReplicator_IsCfnResource ¶ added in v2.103.0
func CfnReplicator_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReplicator_IsConstruct ¶ added in v2.103.0
func CfnReplicator_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnServerlessCluster_CFN_RESOURCE_TYPE_NAME ¶ added in v2.38.0
func CfnServerlessCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnServerlessCluster_IsCfnElement ¶ added in v2.38.0
func CfnServerlessCluster_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnServerlessCluster_IsCfnResource ¶ added in v2.38.0
func CfnServerlessCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnServerlessCluster_IsConstruct ¶ added in v2.38.0
func CfnServerlessCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnVpcConnection_CFN_RESOURCE_TYPE_NAME ¶ added in v2.78.0
func CfnVpcConnection_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcConnection_IsCfnElement ¶ added in v2.78.0
func CfnVpcConnection_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnVpcConnection_IsCfnResource ¶ added in v2.78.0
func CfnVpcConnection_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVpcConnection_IsConstruct ¶ added in v2.78.0
func CfnVpcConnection_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnBatchScramSecret_Override ¶ added in v2.16.0
func NewCfnBatchScramSecret_Override(c CfnBatchScramSecret, scope constructs.Construct, id *string, props *CfnBatchScramSecretProps)
func NewCfnClusterPolicy_Override ¶ added in v2.78.0
func NewCfnClusterPolicy_Override(c CfnClusterPolicy, scope constructs.Construct, id *string, props *CfnClusterPolicyProps)
func NewCfnCluster_Override ¶
func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
func NewCfnConfiguration_Override ¶ added in v2.16.0
func NewCfnConfiguration_Override(c CfnConfiguration, scope constructs.Construct, id *string, props *CfnConfigurationProps)
func NewCfnReplicator_Override ¶ added in v2.103.0
func NewCfnReplicator_Override(c CfnReplicator, scope constructs.Construct, id *string, props *CfnReplicatorProps)
func NewCfnServerlessCluster_Override ¶ added in v2.38.0
func NewCfnServerlessCluster_Override(c CfnServerlessCluster, scope constructs.Construct, id *string, props *CfnServerlessClusterProps)
func NewCfnVpcConnection_Override ¶ added in v2.78.0
func NewCfnVpcConnection_Override(c CfnVpcConnection, scope constructs.Construct, id *string, props *CfnVpcConnectionProps)
Types ¶
type CfnBatchScramSecret ¶ added in v2.16.0
type CfnBatchScramSecret interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
ClusterArn() *string
SetClusterArn(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
SecretArnList() *[]*string
SetSecretArnList(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBatchScramSecret := awscdk.Aws_msk.NewCfnBatchScramSecret(this, jsii.String("MyCfnBatchScramSecret"), &CfnBatchScramSecretProps{
ClusterArn: jsii.String("clusterArn"),
// the properties below are optional
SecretArnList: []*string{
jsii.String("secretArnList"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html
func NewCfnBatchScramSecret ¶ added in v2.16.0
func NewCfnBatchScramSecret(scope constructs.Construct, id *string, props *CfnBatchScramSecretProps) CfnBatchScramSecret
type CfnBatchScramSecretProps ¶ added in v2.16.0
type CfnBatchScramSecretProps struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html#cfn-msk-batchscramsecret-clusterarn
//
ClusterArn *string `field:"required" json:"clusterArn" yaml:"clusterArn"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html#cfn-msk-batchscramsecret-secretarnlist
//
SecretArnList *[]*string `field:"optional" json:"secretArnList" yaml:"secretArnList"`
}
Properties for defining a `CfnBatchScramSecret`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBatchScramSecretProps := &CfnBatchScramSecretProps{
ClusterArn: jsii.String("clusterArn"),
// the properties below are optional
SecretArnList: []*string{
jsii.String("secretArnList"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html
type CfnCluster ¶
type CfnCluster interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
AttrArn() *string
BrokerNodeGroupInfo() interface{}
SetBrokerNodeGroupInfo(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
ClientAuthentication() interface{}
SetClientAuthentication(val interface{})
ClusterName() *string
SetClusterName(val *string)
ConfigurationInfo() interface{}
SetConfigurationInfo(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The current version of the MSK cluster.
CurrentVersion() *string
SetCurrentVersion(val *string)
EncryptionInfo() interface{}
SetEncryptionInfo(val interface{})
EnhancedMonitoring() *string
SetEnhancedMonitoring(val *string)
KafkaVersion() *string
SetKafkaVersion(val *string)
LoggingInfo() interface{}
SetLoggingInfo(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
NumberOfBrokerNodes() *float64
SetNumberOfBrokerNodes(val *float64)
OpenMonitoring() interface{}
SetOpenMonitoring(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
StorageMode() *string
SetStorageMode(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// A key-value pair to associate with a resource.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCluster := awscdk.Aws_msk.NewCfnCluster(this, jsii.String("MyCfnCluster"), &CfnClusterProps{
BrokerNodeGroupInfo: &BrokerNodeGroupInfoProperty{
ClientSubnets: []*string{
jsii.String("clientSubnets"),
},
InstanceType: jsii.String("instanceType"),
// the properties below are optional
BrokerAzDistribution: jsii.String("brokerAzDistribution"),
ConnectivityInfo: &ConnectivityInfoProperty{
PublicAccess: &PublicAccessProperty{
Type: jsii.String("type"),
},
VpcConnectivity: &VpcConnectivityProperty{
ClientAuthentication: &VpcConnectivityClientAuthenticationProperty{
Sasl: &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
},
},
},
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
StorageInfo: &StorageInfoProperty{
EbsStorageInfo: &EBSStorageInfoProperty{
ProvisionedThroughput: &ProvisionedThroughputProperty{
Enabled: jsii.Boolean(false),
VolumeThroughput: jsii.Number(123),
},
VolumeSize: jsii.Number(123),
},
},
},
ClusterName: jsii.String("clusterName"),
KafkaVersion: jsii.String("kafkaVersion"),
NumberOfBrokerNodes: jsii.Number(123),
// the properties below are optional
ClientAuthentication: &ClientAuthenticationProperty{
Sasl: &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &ScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &TlsProperty{
CertificateAuthorityArnList: []*string{
jsii.String("certificateAuthorityArnList"),
},
Enabled: jsii.Boolean(false),
},
Unauthenticated: &UnauthenticatedProperty{
Enabled: jsii.Boolean(false),
},
},
ConfigurationInfo: &ConfigurationInfoProperty{
Arn: jsii.String("arn"),
Revision: jsii.Number(123),
},
CurrentVersion: jsii.String("currentVersion"),
EncryptionInfo: &EncryptionInfoProperty{
EncryptionAtRest: &EncryptionAtRestProperty{
DataVolumeKmsKeyId: jsii.String("dataVolumeKmsKeyId"),
},
EncryptionInTransit: &EncryptionInTransitProperty{
ClientBroker: jsii.String("clientBroker"),
InCluster: jsii.Boolean(false),
},
},
EnhancedMonitoring: jsii.String("enhancedMonitoring"),
LoggingInfo: &LoggingInfoProperty{
BrokerLogs: &BrokerLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LogGroup: jsii.String("logGroup"),
},
Firehose: &FirehoseProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
DeliveryStream: jsii.String("deliveryStream"),
},
S3: &S3Property{
Enabled: jsii.Boolean(false),
// the properties below are optional
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
},
},
OpenMonitoring: &OpenMonitoringProperty{
Prometheus: &PrometheusProperty{
JmxExporter: &JmxExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
NodeExporter: &NodeExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
},
},
StorageMode: jsii.String("storageMode"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
func NewCfnCluster ¶
func NewCfnCluster(scope constructs.Construct, id *string, props *CfnClusterProps) CfnCluster
type CfnClusterPolicy ¶ added in v2.78.0
type CfnClusterPolicy interface {
awscdk.CfnResource
awscdk.IInspectable
// The current version of the policy attached to the specified cluster.
AttrCurrentVersion() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterArn() *string
SetClusterArn(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Resource policy for the cluster.
Policy() interface{}
SetPolicy(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Create or update cluster policy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var policy interface{}
cfnClusterPolicy := awscdk.Aws_msk.NewCfnClusterPolicy(this, jsii.String("MyCfnClusterPolicy"), &CfnClusterPolicyProps{
ClusterArn: jsii.String("clusterArn"),
Policy: policy,
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html
func NewCfnClusterPolicy ¶ added in v2.78.0
func NewCfnClusterPolicy(scope constructs.Construct, id *string, props *CfnClusterPolicyProps) CfnClusterPolicy
type CfnClusterPolicyProps ¶ added in v2.78.0
type CfnClusterPolicyProps struct {
// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html#cfn-msk-clusterpolicy-clusterarn
//
ClusterArn *string `field:"required" json:"clusterArn" yaml:"clusterArn"`
// Resource policy for the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html#cfn-msk-clusterpolicy-policy
//
Policy interface{} `field:"required" json:"policy" yaml:"policy"`
}
Properties for defining a `CfnClusterPolicy`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var policy interface{}
cfnClusterPolicyProps := &CfnClusterPolicyProps{
ClusterArn: jsii.String("clusterArn"),
Policy: policy,
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-clusterpolicy.html
type CfnClusterProps ¶
type CfnClusterProps struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-brokernodegroupinfo
//
BrokerNodeGroupInfo interface{} `field:"required" json:"brokerNodeGroupInfo" yaml:"brokerNodeGroupInfo"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clustername
//
ClusterName *string `field:"required" json:"clusterName" yaml:"clusterName"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-kafkaversion
//
KafkaVersion *string `field:"required" json:"kafkaVersion" yaml:"kafkaVersion"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-numberofbrokernodes
//
NumberOfBrokerNodes *float64 `field:"required" json:"numberOfBrokerNodes" yaml:"numberOfBrokerNodes"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clientauthentication
//
ClientAuthentication interface{} `field:"optional" json:"clientAuthentication" yaml:"clientAuthentication"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-configurationinfo
//
ConfigurationInfo interface{} `field:"optional" json:"configurationInfo" yaml:"configurationInfo"`
// The current version of the MSK cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-currentversion
//
CurrentVersion *string `field:"optional" json:"currentVersion" yaml:"currentVersion"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-encryptioninfo
//
EncryptionInfo interface{} `field:"optional" json:"encryptionInfo" yaml:"encryptionInfo"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-enhancedmonitoring
//
EnhancedMonitoring *string `field:"optional" json:"enhancedMonitoring" yaml:"enhancedMonitoring"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-logginginfo
//
LoggingInfo interface{} `field:"optional" json:"loggingInfo" yaml:"loggingInfo"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-openmonitoring
//
OpenMonitoring interface{} `field:"optional" json:"openMonitoring" yaml:"openMonitoring"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-storagemode
//
StorageMode *string `field:"optional" json:"storageMode" yaml:"storageMode"`
// A key-value pair to associate with a resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCluster`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnClusterProps := &CfnClusterProps{
BrokerNodeGroupInfo: &BrokerNodeGroupInfoProperty{
ClientSubnets: []*string{
jsii.String("clientSubnets"),
},
InstanceType: jsii.String("instanceType"),
// the properties below are optional
BrokerAzDistribution: jsii.String("brokerAzDistribution"),
ConnectivityInfo: &ConnectivityInfoProperty{
PublicAccess: &PublicAccessProperty{
Type: jsii.String("type"),
},
VpcConnectivity: &VpcConnectivityProperty{
ClientAuthentication: &VpcConnectivityClientAuthenticationProperty{
Sasl: &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
},
},
},
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
StorageInfo: &StorageInfoProperty{
EbsStorageInfo: &EBSStorageInfoProperty{
ProvisionedThroughput: &ProvisionedThroughputProperty{
Enabled: jsii.Boolean(false),
VolumeThroughput: jsii.Number(123),
},
VolumeSize: jsii.Number(123),
},
},
},
ClusterName: jsii.String("clusterName"),
KafkaVersion: jsii.String("kafkaVersion"),
NumberOfBrokerNodes: jsii.Number(123),
// the properties below are optional
ClientAuthentication: &ClientAuthenticationProperty{
Sasl: &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &ScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &TlsProperty{
CertificateAuthorityArnList: []*string{
jsii.String("certificateAuthorityArnList"),
},
Enabled: jsii.Boolean(false),
},
Unauthenticated: &UnauthenticatedProperty{
Enabled: jsii.Boolean(false),
},
},
ConfigurationInfo: &ConfigurationInfoProperty{
Arn: jsii.String("arn"),
Revision: jsii.Number(123),
},
CurrentVersion: jsii.String("currentVersion"),
EncryptionInfo: &EncryptionInfoProperty{
EncryptionAtRest: &EncryptionAtRestProperty{
DataVolumeKmsKeyId: jsii.String("dataVolumeKmsKeyId"),
},
EncryptionInTransit: &EncryptionInTransitProperty{
ClientBroker: jsii.String("clientBroker"),
InCluster: jsii.Boolean(false),
},
},
EnhancedMonitoring: jsii.String("enhancedMonitoring"),
LoggingInfo: &LoggingInfoProperty{
BrokerLogs: &BrokerLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LogGroup: jsii.String("logGroup"),
},
Firehose: &FirehoseProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
DeliveryStream: jsii.String("deliveryStream"),
},
S3: &S3Property{
Enabled: jsii.Boolean(false),
// the properties below are optional
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
},
},
OpenMonitoring: &OpenMonitoringProperty{
Prometheus: &PrometheusProperty{
JmxExporter: &JmxExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
NodeExporter: &NodeExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
},
},
StorageMode: jsii.String("storageMode"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
type CfnCluster_BrokerLogsProperty ¶
type CfnCluster_BrokerLogsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokerlogs.html#cfn-msk-cluster-brokerlogs-cloudwatchlogs
//
CloudWatchLogs interface{} `field:"optional" json:"cloudWatchLogs" yaml:"cloudWatchLogs"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokerlogs.html#cfn-msk-cluster-brokerlogs-firehose
//
Firehose interface{} `field:"optional" json:"firehose" yaml:"firehose"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokerlogs.html#cfn-msk-cluster-brokerlogs-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
brokerLogsProperty := &BrokerLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LogGroup: jsii.String("logGroup"),
},
Firehose: &FirehoseProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
DeliveryStream: jsii.String("deliveryStream"),
},
S3: &S3Property{
Enabled: jsii.Boolean(false),
// the properties below are optional
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
}
type CfnCluster_BrokerNodeGroupInfoProperty ¶
type CfnCluster_BrokerNodeGroupInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-clientsubnets
//
ClientSubnets *[]*string `field:"required" json:"clientSubnets" yaml:"clientSubnets"`
// The type of Amazon EC2 instances to use for brokers.
//
// The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-instancetype
//
InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-brokerazdistribution
//
BrokerAzDistribution *string `field:"optional" json:"brokerAzDistribution" yaml:"brokerAzDistribution"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-connectivityinfo
//
ConnectivityInfo interface{} `field:"optional" json:"connectivityInfo" yaml:"connectivityInfo"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-securitygroups
//
SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-storageinfo
//
StorageInfo interface{} `field:"optional" json:"storageInfo" yaml:"storageInfo"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
brokerNodeGroupInfoProperty := &BrokerNodeGroupInfoProperty{
ClientSubnets: []*string{
jsii.String("clientSubnets"),
},
InstanceType: jsii.String("instanceType"),
// the properties below are optional
BrokerAzDistribution: jsii.String("brokerAzDistribution"),
ConnectivityInfo: &ConnectivityInfoProperty{
PublicAccess: &PublicAccessProperty{
Type: jsii.String("type"),
},
VpcConnectivity: &VpcConnectivityProperty{
ClientAuthentication: &VpcConnectivityClientAuthenticationProperty{
Sasl: &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
},
},
},
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
StorageInfo: &StorageInfoProperty{
EbsStorageInfo: &EBSStorageInfoProperty{
ProvisionedThroughput: &ProvisionedThroughputProperty{
Enabled: jsii.Boolean(false),
VolumeThroughput: jsii.Number(123),
},
VolumeSize: jsii.Number(123),
},
},
}
type CfnCluster_ClientAuthenticationProperty ¶
type CfnCluster_ClientAuthenticationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-clientauthentication.html#cfn-msk-cluster-clientauthentication-sasl
//
Sasl interface{} `field:"optional" json:"sasl" yaml:"sasl"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-clientauthentication.html#cfn-msk-cluster-clientauthentication-tls
//
Tls interface{} `field:"optional" json:"tls" yaml:"tls"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-clientauthentication.html#cfn-msk-cluster-clientauthentication-unauthenticated
//
Unauthenticated interface{} `field:"optional" json:"unauthenticated" yaml:"unauthenticated"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
clientAuthenticationProperty := &ClientAuthenticationProperty{
Sasl: &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &ScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &TlsProperty{
CertificateAuthorityArnList: []*string{
jsii.String("certificateAuthorityArnList"),
},
Enabled: jsii.Boolean(false),
},
Unauthenticated: &UnauthenticatedProperty{
Enabled: jsii.Boolean(false),
},
}
type CfnCluster_CloudWatchLogsProperty ¶
type CfnCluster_CloudWatchLogsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-cloudwatchlogs.html#cfn-msk-cluster-cloudwatchlogs-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-cloudwatchlogs.html#cfn-msk-cluster-cloudwatchlogs-loggroup
//
LogGroup *string `field:"optional" json:"logGroup" yaml:"logGroup"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cloudWatchLogsProperty := &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LogGroup: jsii.String("logGroup"),
}
type CfnCluster_ConfigurationInfoProperty ¶
type CfnCluster_ConfigurationInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-configurationinfo.html#cfn-msk-cluster-configurationinfo-arn
//
Arn *string `field:"required" json:"arn" yaml:"arn"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-configurationinfo.html#cfn-msk-cluster-configurationinfo-revision
//
Revision *float64 `field:"required" json:"revision" yaml:"revision"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
configurationInfoProperty := &ConfigurationInfoProperty{
Arn: jsii.String("arn"),
Revision: jsii.Number(123),
}
type CfnCluster_ConnectivityInfoProperty ¶
type CfnCluster_ConnectivityInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-connectivityinfo.html#cfn-msk-cluster-connectivityinfo-publicaccess
//
PublicAccess interface{} `field:"optional" json:"publicAccess" yaml:"publicAccess"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-connectivityinfo.html#cfn-msk-cluster-connectivityinfo-vpcconnectivity
//
VpcConnectivity interface{} `field:"optional" json:"vpcConnectivity" yaml:"vpcConnectivity"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
connectivityInfoProperty := &ConnectivityInfoProperty{
PublicAccess: &PublicAccessProperty{
Type: jsii.String("type"),
},
VpcConnectivity: &VpcConnectivityProperty{
ClientAuthentication: &VpcConnectivityClientAuthenticationProperty{
Sasl: &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
},
},
},
}
type CfnCluster_EBSStorageInfoProperty ¶
type CfnCluster_EBSStorageInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-ebsstorageinfo.html#cfn-msk-cluster-ebsstorageinfo-provisionedthroughput
//
ProvisionedThroughput interface{} `field:"optional" json:"provisionedThroughput" yaml:"provisionedThroughput"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-ebsstorageinfo.html#cfn-msk-cluster-ebsstorageinfo-volumesize
//
VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eBSStorageInfoProperty := &EBSStorageInfoProperty{
ProvisionedThroughput: &ProvisionedThroughputProperty{
Enabled: jsii.Boolean(false),
VolumeThroughput: jsii.Number(123),
},
VolumeSize: jsii.Number(123),
}
type CfnCluster_EncryptionAtRestProperty ¶
type CfnCluster_EncryptionAtRestProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionatrest.html#cfn-msk-cluster-encryptionatrest-datavolumekmskeyid
//
DataVolumeKmsKeyId *string `field:"required" json:"dataVolumeKmsKeyId" yaml:"dataVolumeKmsKeyId"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
encryptionAtRestProperty := &EncryptionAtRestProperty{
DataVolumeKmsKeyId: jsii.String("dataVolumeKmsKeyId"),
}
type CfnCluster_EncryptionInTransitProperty ¶
type CfnCluster_EncryptionInTransitProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html#cfn-msk-cluster-encryptionintransit-clientbroker
//
ClientBroker *string `field:"optional" json:"clientBroker" yaml:"clientBroker"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html#cfn-msk-cluster-encryptionintransit-incluster
//
InCluster interface{} `field:"optional" json:"inCluster" yaml:"inCluster"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
encryptionInTransitProperty := &EncryptionInTransitProperty{
ClientBroker: jsii.String("clientBroker"),
InCluster: jsii.Boolean(false),
}
type CfnCluster_EncryptionInfoProperty ¶
type CfnCluster_EncryptionInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptioninfo.html#cfn-msk-cluster-encryptioninfo-encryptionatrest
//
EncryptionAtRest interface{} `field:"optional" json:"encryptionAtRest" yaml:"encryptionAtRest"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptioninfo.html#cfn-msk-cluster-encryptioninfo-encryptionintransit
//
EncryptionInTransit interface{} `field:"optional" json:"encryptionInTransit" yaml:"encryptionInTransit"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
encryptionInfoProperty := &EncryptionInfoProperty{
EncryptionAtRest: &EncryptionAtRestProperty{
DataVolumeKmsKeyId: jsii.String("dataVolumeKmsKeyId"),
},
EncryptionInTransit: &EncryptionInTransitProperty{
ClientBroker: jsii.String("clientBroker"),
InCluster: jsii.Boolean(false),
},
}
type CfnCluster_FirehoseProperty ¶
type CfnCluster_FirehoseProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-firehose.html#cfn-msk-cluster-firehose-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-firehose.html#cfn-msk-cluster-firehose-deliverystream
//
DeliveryStream *string `field:"optional" json:"deliveryStream" yaml:"deliveryStream"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
firehoseProperty := &FirehoseProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
DeliveryStream: jsii.String("deliveryStream"),
}
type CfnCluster_IamProperty ¶
type CfnCluster_IamProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-iam.html#cfn-msk-cluster-iam-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
iamProperty := &IamProperty{
Enabled: jsii.Boolean(false),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-iam.html
type CfnCluster_JmxExporterProperty ¶
type CfnCluster_JmxExporterProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-jmxexporter.html#cfn-msk-cluster-jmxexporter-enabledinbroker
//
EnabledInBroker interface{} `field:"required" json:"enabledInBroker" yaml:"enabledInBroker"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
jmxExporterProperty := &JmxExporterProperty{
EnabledInBroker: jsii.Boolean(false),
}
type CfnCluster_LoggingInfoProperty ¶
type CfnCluster_LoggingInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-logginginfo.html#cfn-msk-cluster-logginginfo-brokerlogs
//
BrokerLogs interface{} `field:"required" json:"brokerLogs" yaml:"brokerLogs"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
loggingInfoProperty := &LoggingInfoProperty{
BrokerLogs: &BrokerLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LogGroup: jsii.String("logGroup"),
},
Firehose: &FirehoseProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
DeliveryStream: jsii.String("deliveryStream"),
},
S3: &S3Property{
Enabled: jsii.Boolean(false),
// the properties below are optional
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
},
}
type CfnCluster_NodeExporterProperty ¶
type CfnCluster_NodeExporterProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-nodeexporter.html#cfn-msk-cluster-nodeexporter-enabledinbroker
//
EnabledInBroker interface{} `field:"required" json:"enabledInBroker" yaml:"enabledInBroker"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
nodeExporterProperty := &NodeExporterProperty{
EnabledInBroker: jsii.Boolean(false),
}
type CfnCluster_OpenMonitoringProperty ¶
type CfnCluster_OpenMonitoringProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-openmonitoring.html#cfn-msk-cluster-openmonitoring-prometheus
//
Prometheus interface{} `field:"required" json:"prometheus" yaml:"prometheus"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
openMonitoringProperty := &OpenMonitoringProperty{
Prometheus: &PrometheusProperty{
JmxExporter: &JmxExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
NodeExporter: &NodeExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
},
}
type CfnCluster_PrometheusProperty ¶
type CfnCluster_PrometheusProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html#cfn-msk-cluster-prometheus-jmxexporter
//
JmxExporter interface{} `field:"optional" json:"jmxExporter" yaml:"jmxExporter"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html#cfn-msk-cluster-prometheus-nodeexporter
//
NodeExporter interface{} `field:"optional" json:"nodeExporter" yaml:"nodeExporter"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
prometheusProperty := &PrometheusProperty{
JmxExporter: &JmxExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
NodeExporter: &NodeExporterProperty{
EnabledInBroker: jsii.Boolean(false),
},
}
type CfnCluster_ProvisionedThroughputProperty ¶ added in v2.11.0
type CfnCluster_ProvisionedThroughputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-provisionedthroughput.html#cfn-msk-cluster-provisionedthroughput-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-provisionedthroughput.html#cfn-msk-cluster-provisionedthroughput-volumethroughput
//
VolumeThroughput *float64 `field:"optional" json:"volumeThroughput" yaml:"volumeThroughput"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
provisionedThroughputProperty := &ProvisionedThroughputProperty{
Enabled: jsii.Boolean(false),
VolumeThroughput: jsii.Number(123),
}
type CfnCluster_PublicAccessProperty ¶
type CfnCluster_PublicAccessProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-publicaccess.html#cfn-msk-cluster-publicaccess-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
publicAccessProperty := &PublicAccessProperty{
Type: jsii.String("type"),
}
type CfnCluster_S3Property ¶
type CfnCluster_S3Property struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html#cfn-msk-cluster-s3-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html#cfn-msk-cluster-s3-bucket
//
Bucket *string `field:"optional" json:"bucket" yaml:"bucket"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html#cfn-msk-cluster-s3-prefix
//
Prefix *string `field:"optional" json:"prefix" yaml:"prefix"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3Property := &S3Property{
Enabled: jsii.Boolean(false),
// the properties below are optional
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html
type CfnCluster_SaslProperty ¶
type CfnCluster_SaslProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-sasl.html#cfn-msk-cluster-sasl-iam
//
Iam interface{} `field:"optional" json:"iam" yaml:"iam"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-sasl.html#cfn-msk-cluster-sasl-scram
//
Scram interface{} `field:"optional" json:"scram" yaml:"scram"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
saslProperty := &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &ScramProperty{
Enabled: jsii.Boolean(false),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-sasl.html
type CfnCluster_ScramProperty ¶
type CfnCluster_ScramProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-scram.html#cfn-msk-cluster-scram-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
scramProperty := &ScramProperty{
Enabled: jsii.Boolean(false),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-scram.html
type CfnCluster_StorageInfoProperty ¶
type CfnCluster_StorageInfoProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html#cfn-msk-cluster-storageinfo-ebsstorageinfo
//
EbsStorageInfo interface{} `field:"optional" json:"ebsStorageInfo" yaml:"ebsStorageInfo"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
storageInfoProperty := &StorageInfoProperty{
EbsStorageInfo: &EBSStorageInfoProperty{
ProvisionedThroughput: &ProvisionedThroughputProperty{
Enabled: jsii.Boolean(false),
VolumeThroughput: jsii.Number(123),
},
VolumeSize: jsii.Number(123),
},
}
type CfnCluster_TlsProperty ¶
type CfnCluster_TlsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html#cfn-msk-cluster-tls-certificateauthorityarnlist
//
CertificateAuthorityArnList *[]*string `field:"optional" json:"certificateAuthorityArnList" yaml:"certificateAuthorityArnList"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html#cfn-msk-cluster-tls-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
tlsProperty := &TlsProperty{
CertificateAuthorityArnList: []*string{
jsii.String("certificateAuthorityArnList"),
},
Enabled: jsii.Boolean(false),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html
type CfnCluster_UnauthenticatedProperty ¶
type CfnCluster_UnauthenticatedProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-unauthenticated.html#cfn-msk-cluster-unauthenticated-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
unauthenticatedProperty := &UnauthenticatedProperty{
Enabled: jsii.Boolean(false),
}
type CfnCluster_VpcConnectivityClientAuthenticationProperty ¶ added in v2.55.0
type CfnCluster_VpcConnectivityClientAuthenticationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html#cfn-msk-cluster-vpcconnectivityclientauthentication-sasl
//
Sasl interface{} `field:"optional" json:"sasl" yaml:"sasl"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html#cfn-msk-cluster-vpcconnectivityclientauthentication-tls
//
Tls interface{} `field:"optional" json:"tls" yaml:"tls"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConnectivityClientAuthenticationProperty := &VpcConnectivityClientAuthenticationProperty{
Sasl: &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
},
}
type CfnCluster_VpcConnectivityIamProperty ¶ added in v2.55.0
type CfnCluster_VpcConnectivityIamProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityiam.html#cfn-msk-cluster-vpcconnectivityiam-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConnectivityIamProperty := &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
}
type CfnCluster_VpcConnectivityProperty ¶ added in v2.55.0
type CfnCluster_VpcConnectivityProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivity.html#cfn-msk-cluster-vpcconnectivity-clientauthentication
//
ClientAuthentication interface{} `field:"optional" json:"clientAuthentication" yaml:"clientAuthentication"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConnectivityProperty := &VpcConnectivityProperty{
ClientAuthentication: &VpcConnectivityClientAuthenticationProperty{
Sasl: &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
},
Tls: &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
},
},
}
type CfnCluster_VpcConnectivitySaslProperty ¶ added in v2.55.0
type CfnCluster_VpcConnectivitySaslProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html#cfn-msk-cluster-vpcconnectivitysasl-iam
//
Iam interface{} `field:"optional" json:"iam" yaml:"iam"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html#cfn-msk-cluster-vpcconnectivitysasl-scram
//
Scram interface{} `field:"optional" json:"scram" yaml:"scram"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConnectivitySaslProperty := &VpcConnectivitySaslProperty{
Iam: &VpcConnectivityIamProperty{
Enabled: jsii.Boolean(false),
},
Scram: &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
},
}
type CfnCluster_VpcConnectivityScramProperty ¶ added in v2.55.0
type CfnCluster_VpcConnectivityScramProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityscram.html#cfn-msk-cluster-vpcconnectivityscram-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConnectivityScramProperty := &VpcConnectivityScramProperty{
Enabled: jsii.Boolean(false),
}
type CfnCluster_VpcConnectivityTlsProperty ¶ added in v2.55.0
type CfnCluster_VpcConnectivityTlsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitytls.html#cfn-msk-cluster-vpcconnectivitytls-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConnectivityTlsProperty := &VpcConnectivityTlsProperty{
Enabled: jsii.Boolean(false),
}
type CfnConfiguration ¶ added in v2.16.0
type CfnConfiguration interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrLatestRevisionCreationTime() *string
AttrLatestRevisionDescription() *string
AttrLatestRevisionRevision() *float64
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
KafkaVersionsList() *[]*string
SetKafkaVersionsList(val *[]*string)
LatestRevision() interface{}
SetLatestRevision(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
ServerProperties() *string
SetServerProperties(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnConfiguration := awscdk.Aws_msk.NewCfnConfiguration(this, jsii.String("MyCfnConfiguration"), &CfnConfigurationProps{
Name: jsii.String("name"),
ServerProperties: jsii.String("serverProperties"),
// the properties below are optional
Description: jsii.String("description"),
KafkaVersionsList: []*string{
jsii.String("kafkaVersionsList"),
},
LatestRevision: &LatestRevisionProperty{
CreationTime: jsii.String("creationTime"),
Description: jsii.String("description"),
Revision: jsii.Number(123),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html
func NewCfnConfiguration ¶ added in v2.16.0
func NewCfnConfiguration(scope constructs.Construct, id *string, props *CfnConfigurationProps) CfnConfiguration
type CfnConfigurationProps ¶ added in v2.16.0
type CfnConfigurationProps struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-serverproperties
//
ServerProperties *string `field:"required" json:"serverProperties" yaml:"serverProperties"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-kafkaversionslist
//
KafkaVersionsList *[]*string `field:"optional" json:"kafkaVersionsList" yaml:"kafkaVersionsList"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html#cfn-msk-configuration-latestrevision
//
LatestRevision interface{} `field:"optional" json:"latestRevision" yaml:"latestRevision"`
}
Properties for defining a `CfnConfiguration`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnConfigurationProps := &CfnConfigurationProps{
Name: jsii.String("name"),
ServerProperties: jsii.String("serverProperties"),
// the properties below are optional
Description: jsii.String("description"),
KafkaVersionsList: []*string{
jsii.String("kafkaVersionsList"),
},
LatestRevision: &LatestRevisionProperty{
CreationTime: jsii.String("creationTime"),
Description: jsii.String("description"),
Revision: jsii.Number(123),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html
type CfnConfiguration_LatestRevisionProperty ¶ added in v2.98.0
type CfnConfiguration_LatestRevisionProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-configuration-latestrevision.html#cfn-msk-configuration-latestrevision-creationtime
//
CreationTime *string `field:"optional" json:"creationTime" yaml:"creationTime"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-configuration-latestrevision.html#cfn-msk-configuration-latestrevision-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-configuration-latestrevision.html#cfn-msk-configuration-latestrevision-revision
//
Revision *float64 `field:"optional" json:"revision" yaml:"revision"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
latestRevisionProperty := &LatestRevisionProperty{
CreationTime: jsii.String("creationTime"),
Description: jsii.String("description"),
Revision: jsii.Number(123),
}
type CfnReplicator ¶ added in v2.103.0
type CfnReplicator interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// Amazon Resource Name (ARN) for the created replicator.
AttrReplicatorArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The current version number of the replicator.
CurrentVersion() *string
SetCurrentVersion(val *string)
// A summary description of the replicator.
Description() *string
SetDescription(val *string)
// Kafka Clusters to use in setting up sources / targets for replication.
KafkaClusters() interface{}
SetKafkaClusters(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
ReplicationInfoList() interface{}
SetReplicationInfoList(val interface{})
// The name of the replicator.
ReplicatorName() *string
SetReplicatorName(val *string)
// The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).
ServiceExecutionRoleArn() *string
SetServiceExecutionRoleArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// List of tags to attach to created Replicator.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates the replicator.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnReplicator := awscdk.Aws_msk.NewCfnReplicator(this, jsii.String("MyCfnReplicator"), &CfnReplicatorProps{
KafkaClusters: []interface{}{
&KafkaClusterProperty{
AmazonMskCluster: &AmazonMskClusterProperty{
MskClusterArn: jsii.String("mskClusterArn"),
},
VpcConfig: &KafkaClusterClientVpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
},
},
},
ReplicationInfoList: []interface{}{
&ReplicationInfoProperty{
ConsumerGroupReplication: &ConsumerGroupReplicationProperty{
ConsumerGroupsToReplicate: []*string{
jsii.String("consumerGroupsToReplicate"),
},
// the properties below are optional
ConsumerGroupsToExclude: []*string{
jsii.String("consumerGroupsToExclude"),
},
DetectAndCopyNewConsumerGroups: jsii.Boolean(false),
SynchroniseConsumerGroupOffsets: jsii.Boolean(false),
},
SourceKafkaClusterArn: jsii.String("sourceKafkaClusterArn"),
TargetCompressionType: jsii.String("targetCompressionType"),
TargetKafkaClusterArn: jsii.String("targetKafkaClusterArn"),
TopicReplication: &TopicReplicationProperty{
TopicsToReplicate: []*string{
jsii.String("topicsToReplicate"),
},
// the properties below are optional
CopyAccessControlListsForTopics: jsii.Boolean(false),
CopyTopicConfigurations: jsii.Boolean(false),
DetectAndCopyNewTopics: jsii.Boolean(false),
StartingPosition: &ReplicationStartingPositionProperty{
Type: jsii.String("type"),
},
TopicNameConfiguration: &ReplicationTopicNameConfigurationProperty{
Type: jsii.String("type"),
},
TopicsToExclude: []*string{
jsii.String("topicsToExclude"),
},
},
},
},
ReplicatorName: jsii.String("replicatorName"),
ServiceExecutionRoleArn: jsii.String("serviceExecutionRoleArn"),
// the properties below are optional
CurrentVersion: jsii.String("currentVersion"),
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html
func NewCfnReplicator ¶ added in v2.103.0
func NewCfnReplicator(scope constructs.Construct, id *string, props *CfnReplicatorProps) CfnReplicator
type CfnReplicatorProps ¶ added in v2.103.0
type CfnReplicatorProps struct {
// Kafka Clusters to use in setting up sources / targets for replication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-kafkaclusters
//
KafkaClusters interface{} `field:"required" json:"kafkaClusters" yaml:"kafkaClusters"`
// A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-replicationinfolist
//
ReplicationInfoList interface{} `field:"required" json:"replicationInfoList" yaml:"replicationInfoList"`
// The name of the replicator.
//
// Alpha-numeric characters with '-' are allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-replicatorname
//
ReplicatorName *string `field:"required" json:"replicatorName" yaml:"replicatorName"`
// The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-serviceexecutionrolearn
//
ServiceExecutionRoleArn *string `field:"required" json:"serviceExecutionRoleArn" yaml:"serviceExecutionRoleArn"`
// The current version number of the replicator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-currentversion
//
CurrentVersion *string `field:"optional" json:"currentVersion" yaml:"currentVersion"`
// A summary description of the replicator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// List of tags to attach to created Replicator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html#cfn-msk-replicator-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnReplicator`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnReplicatorProps := &CfnReplicatorProps{
KafkaClusters: []interface{}{
&KafkaClusterProperty{
AmazonMskCluster: &AmazonMskClusterProperty{
MskClusterArn: jsii.String("mskClusterArn"),
},
VpcConfig: &KafkaClusterClientVpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
},
},
},
ReplicationInfoList: []interface{}{
&ReplicationInfoProperty{
ConsumerGroupReplication: &ConsumerGroupReplicationProperty{
ConsumerGroupsToReplicate: []*string{
jsii.String("consumerGroupsToReplicate"),
},
// the properties below are optional
ConsumerGroupsToExclude: []*string{
jsii.String("consumerGroupsToExclude"),
},
DetectAndCopyNewConsumerGroups: jsii.Boolean(false),
SynchroniseConsumerGroupOffsets: jsii.Boolean(false),
},
SourceKafkaClusterArn: jsii.String("sourceKafkaClusterArn"),
TargetCompressionType: jsii.String("targetCompressionType"),
TargetKafkaClusterArn: jsii.String("targetKafkaClusterArn"),
TopicReplication: &TopicReplicationProperty{
TopicsToReplicate: []*string{
jsii.String("topicsToReplicate"),
},
// the properties below are optional
CopyAccessControlListsForTopics: jsii.Boolean(false),
CopyTopicConfigurations: jsii.Boolean(false),
DetectAndCopyNewTopics: jsii.Boolean(false),
StartingPosition: &ReplicationStartingPositionProperty{
Type: jsii.String("type"),
},
TopicNameConfiguration: &ReplicationTopicNameConfigurationProperty{
Type: jsii.String("type"),
},
TopicsToExclude: []*string{
jsii.String("topicsToExclude"),
},
},
},
},
ReplicatorName: jsii.String("replicatorName"),
ServiceExecutionRoleArn: jsii.String("serviceExecutionRoleArn"),
// the properties below are optional
CurrentVersion: jsii.String("currentVersion"),
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html
type CfnReplicator_AmazonMskClusterProperty ¶ added in v2.103.0
type CfnReplicator_AmazonMskClusterProperty struct {
// The Amazon Resource Name (ARN) of an Amazon MSK cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-amazonmskcluster.html#cfn-msk-replicator-amazonmskcluster-mskclusterarn
//
MskClusterArn *string `field:"required" json:"mskClusterArn" yaml:"mskClusterArn"`
}
Details of an Amazon MSK Cluster.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
amazonMskClusterProperty := &AmazonMskClusterProperty{
MskClusterArn: jsii.String("mskClusterArn"),
}
type CfnReplicator_ConsumerGroupReplicationProperty ¶ added in v2.103.0
type CfnReplicator_ConsumerGroupReplicationProperty struct {
// List of regular expression patterns indicating the consumer groups to copy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-consumergroupstoreplicate
//
ConsumerGroupsToReplicate *[]*string `field:"required" json:"consumerGroupsToReplicate" yaml:"consumerGroupsToReplicate"`
// List of regular expression patterns indicating the consumer groups that should not be replicated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-consumergroupstoexclude
//
ConsumerGroupsToExclude *[]*string `field:"optional" json:"consumerGroupsToExclude" yaml:"consumerGroupsToExclude"`
// Enables synchronization of consumer groups to target cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-detectandcopynewconsumergroups
//
DetectAndCopyNewConsumerGroups interface{} `field:"optional" json:"detectAndCopyNewConsumerGroups" yaml:"detectAndCopyNewConsumerGroups"`
// Enables synchronization of consumer group offsets to target cluster.
//
// The translated offsets will be written to topic __consumer_offsets.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-synchroniseconsumergroupoffsets
//
SynchroniseConsumerGroupOffsets interface{} `field:"optional" json:"synchroniseConsumerGroupOffsets" yaml:"synchroniseConsumerGroupOffsets"`
}
Details about consumer group replication.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
consumerGroupReplicationProperty := &ConsumerGroupReplicationProperty{
ConsumerGroupsToReplicate: []*string{
jsii.String("consumerGroupsToReplicate"),
},
// the properties below are optional
ConsumerGroupsToExclude: []*string{
jsii.String("consumerGroupsToExclude"),
},
DetectAndCopyNewConsumerGroups: jsii.Boolean(false),
SynchroniseConsumerGroupOffsets: jsii.Boolean(false),
}
type CfnReplicator_KafkaClusterClientVpcConfigProperty ¶ added in v2.103.0
type CfnReplicator_KafkaClusterClientVpcConfigProperty struct {
// The list of subnets in the client VPC to connect to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterclientvpcconfig.html#cfn-msk-replicator-kafkaclusterclientvpcconfig-subnetids
//
SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
// The security groups to attach to the ENIs for the broker nodes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterclientvpcconfig.html#cfn-msk-replicator-kafkaclusterclientvpcconfig-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
}
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
kafkaClusterClientVpcConfigProperty := &KafkaClusterClientVpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
}
type CfnReplicator_KafkaClusterProperty ¶ added in v2.103.0
type CfnReplicator_KafkaClusterProperty struct {
// Details of an Amazon MSK Cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkacluster.html#cfn-msk-replicator-kafkacluster-amazonmskcluster
//
AmazonMskCluster interface{} `field:"required" json:"amazonMskCluster" yaml:"amazonMskCluster"`
// Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkacluster.html#cfn-msk-replicator-kafkacluster-vpcconfig
//
VpcConfig interface{} `field:"required" json:"vpcConfig" yaml:"vpcConfig"`
}
Information about Kafka Cluster to be used as source / target for replication.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
kafkaClusterProperty := &KafkaClusterProperty{
AmazonMskCluster: &AmazonMskClusterProperty{
MskClusterArn: jsii.String("mskClusterArn"),
},
VpcConfig: &KafkaClusterClientVpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
},
}
type CfnReplicator_ReplicationInfoProperty ¶ added in v2.103.0
type CfnReplicator_ReplicationInfoProperty struct {
// Configuration relating to consumer group replication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-consumergroupreplication
//
ConsumerGroupReplication interface{} `field:"required" json:"consumerGroupReplication" yaml:"consumerGroupReplication"`
// The ARN of the source Kafka cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-sourcekafkaclusterarn
//
SourceKafkaClusterArn *string `field:"required" json:"sourceKafkaClusterArn" yaml:"sourceKafkaClusterArn"`
// The compression type to use when producing records to target cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-targetcompressiontype
//
TargetCompressionType *string `field:"required" json:"targetCompressionType" yaml:"targetCompressionType"`
// The ARN of the target Kafka cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-targetkafkaclusterarn
//
TargetKafkaClusterArn *string `field:"required" json:"targetKafkaClusterArn" yaml:"targetKafkaClusterArn"`
// Configuration relating to topic replication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-topicreplication
//
TopicReplication interface{} `field:"required" json:"topicReplication" yaml:"topicReplication"`
}
Specifies configuration for replication between a source and target Kafka cluster.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
replicationInfoProperty := &ReplicationInfoProperty{
ConsumerGroupReplication: &ConsumerGroupReplicationProperty{
ConsumerGroupsToReplicate: []*string{
jsii.String("consumerGroupsToReplicate"),
},
// the properties below are optional
ConsumerGroupsToExclude: []*string{
jsii.String("consumerGroupsToExclude"),
},
DetectAndCopyNewConsumerGroups: jsii.Boolean(false),
SynchroniseConsumerGroupOffsets: jsii.Boolean(false),
},
SourceKafkaClusterArn: jsii.String("sourceKafkaClusterArn"),
TargetCompressionType: jsii.String("targetCompressionType"),
TargetKafkaClusterArn: jsii.String("targetKafkaClusterArn"),
TopicReplication: &TopicReplicationProperty{
TopicsToReplicate: []*string{
jsii.String("topicsToReplicate"),
},
// the properties below are optional
CopyAccessControlListsForTopics: jsii.Boolean(false),
CopyTopicConfigurations: jsii.Boolean(false),
DetectAndCopyNewTopics: jsii.Boolean(false),
StartingPosition: &ReplicationStartingPositionProperty{
Type: jsii.String("type"),
},
TopicNameConfiguration: &ReplicationTopicNameConfigurationProperty{
Type: jsii.String("type"),
},
TopicsToExclude: []*string{
jsii.String("topicsToExclude"),
},
},
}
type CfnReplicator_ReplicationStartingPositionProperty ¶ added in v2.134.0
type CfnReplicator_ReplicationStartingPositionProperty struct {
// The type of replication starting position.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationstartingposition.html#cfn-msk-replicator-replicationstartingposition-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Specifies the position in the topics to start replicating from.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
replicationStartingPositionProperty := &ReplicationStartingPositionProperty{
Type: jsii.String("type"),
}
type CfnReplicator_ReplicationTopicNameConfigurationProperty ¶ added in v2.154.1
type CfnReplicator_ReplicationTopicNameConfigurationProperty struct {
// The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationtopicnameconfiguration.html#cfn-msk-replicator-replicationtopicnameconfiguration-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Configuration for specifying replicated topic names will be the same as their corresponding upstream topics or prefixed with source cluster alias.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
replicationTopicNameConfigurationProperty := &ReplicationTopicNameConfigurationProperty{
Type: jsii.String("type"),
}
type CfnReplicator_TopicReplicationProperty ¶ added in v2.103.0
type CfnReplicator_TopicReplicationProperty struct {
// List of regular expression patterns indicating the topics to copy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-topicstoreplicate
//
TopicsToReplicate *[]*string `field:"required" json:"topicsToReplicate" yaml:"topicsToReplicate"`
// Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-copyaccesscontrollistsfortopics
//
CopyAccessControlListsForTopics interface{} `field:"optional" json:"copyAccessControlListsForTopics" yaml:"copyAccessControlListsForTopics"`
// Whether to periodically configure remote topics to match their corresponding upstream topics.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-copytopicconfigurations
//
CopyTopicConfigurations interface{} `field:"optional" json:"copyTopicConfigurations" yaml:"copyTopicConfigurations"`
// Whether to periodically check for new topics and partitions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-detectandcopynewtopics
//
DetectAndCopyNewTopics interface{} `field:"optional" json:"detectAndCopyNewTopics" yaml:"detectAndCopyNewTopics"`
// Specifies the position in the topics to start replicating from.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-startingposition
//
StartingPosition interface{} `field:"optional" json:"startingPosition" yaml:"startingPosition"`
// Configuration for specifying replicated topic names will be the same as their corresponding upstream topics or prefixed with source cluster alias.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-topicnameconfiguration
//
TopicNameConfiguration interface{} `field:"optional" json:"topicNameConfiguration" yaml:"topicNameConfiguration"`
// List of regular expression patterns indicating the topics that should not be replicated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.html#cfn-msk-replicator-topicreplication-topicstoexclude
//
TopicsToExclude *[]*string `field:"optional" json:"topicsToExclude" yaml:"topicsToExclude"`
}
Details about topic replication.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
topicReplicationProperty := &TopicReplicationProperty{
TopicsToReplicate: []*string{
jsii.String("topicsToReplicate"),
},
// the properties below are optional
CopyAccessControlListsForTopics: jsii.Boolean(false),
CopyTopicConfigurations: jsii.Boolean(false),
DetectAndCopyNewTopics: jsii.Boolean(false),
StartingPosition: &ReplicationStartingPositionProperty{
Type: jsii.String("type"),
},
TopicNameConfiguration: &ReplicationTopicNameConfigurationProperty{
Type: jsii.String("type"),
},
TopicsToExclude: []*string{
jsii.String("topicsToExclude"),
},
}
type CfnServerlessCluster ¶ added in v2.38.0
type CfnServerlessCluster interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
ClientAuthentication() interface{}
SetClientAuthentication(val interface{})
ClusterName() *string
SetClusterName(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// A key-value pair to associate with a resource.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
VpcConfigs() interface{}
SetVpcConfigs(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnServerlessCluster := awscdk.Aws_msk.NewCfnServerlessCluster(this, jsii.String("MyCfnServerlessCluster"), &CfnServerlessClusterProps{
ClientAuthentication: &ClientAuthenticationProperty{
Sasl: &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
},
},
ClusterName: jsii.String("clusterName"),
VpcConfigs: []interface{}{
&VpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
},
},
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnServerlessCluster ¶ added in v2.38.0
func NewCfnServerlessCluster(scope constructs.Construct, id *string, props *CfnServerlessClusterProps) CfnServerlessCluster
type CfnServerlessClusterProps ¶ added in v2.38.0
type CfnServerlessClusterProps struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-clientauthentication
//
ClientAuthentication interface{} `field:"required" json:"clientAuthentication" yaml:"clientAuthentication"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-clustername
//
ClusterName *string `field:"required" json:"clusterName" yaml:"clusterName"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-vpcconfigs
//
VpcConfigs interface{} `field:"required" json:"vpcConfigs" yaml:"vpcConfigs"`
// A key-value pair to associate with a resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html#cfn-msk-serverlesscluster-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnServerlessCluster`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnServerlessClusterProps := &CfnServerlessClusterProps{
ClientAuthentication: &ClientAuthenticationProperty{
Sasl: &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
},
},
ClusterName: jsii.String("clusterName"),
VpcConfigs: []interface{}{
&VpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
},
},
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnServerlessCluster_ClientAuthenticationProperty ¶ added in v2.38.0
type CfnServerlessCluster_ClientAuthenticationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-clientauthentication.html#cfn-msk-serverlesscluster-clientauthentication-sasl
//
Sasl interface{} `field:"required" json:"sasl" yaml:"sasl"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
clientAuthenticationProperty := &ClientAuthenticationProperty{
Sasl: &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
},
}
type CfnServerlessCluster_IamProperty ¶ added in v2.38.0
type CfnServerlessCluster_IamProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-iam.html#cfn-msk-serverlesscluster-iam-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
iamProperty := &IamProperty{
Enabled: jsii.Boolean(false),
}
type CfnServerlessCluster_SaslProperty ¶ added in v2.38.0
type CfnServerlessCluster_SaslProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-sasl.html#cfn-msk-serverlesscluster-sasl-iam
//
Iam interface{} `field:"required" json:"iam" yaml:"iam"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
saslProperty := &SaslProperty{
Iam: &IamProperty{
Enabled: jsii.Boolean(false),
},
}
type CfnServerlessCluster_VpcConfigProperty ¶ added in v2.38.0
type CfnServerlessCluster_VpcConfigProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html#cfn-msk-serverlesscluster-vpcconfig-subnetids
//
SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html#cfn-msk-serverlesscluster-vpcconfig-securitygroups
//
SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConfigProperty := &VpcConfigProperty{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
// the properties below are optional
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
}
type CfnVpcConnection ¶ added in v2.78.0
type CfnVpcConnection interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ARN of the VPC connection.
AttrArn() *string
// The type of private link authentication.
Authentication() *string
SetAuthentication(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
ClientSubnets() *[]*string
SetClientSubnets(val *[]*string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
SecurityGroups() *[]*string
SetSecurityGroups(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// A key-value pair to associate with a resource.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// The Amazon Resource Name (ARN) of the target cluster.
TargetClusterArn() *string
SetTargetClusterArn(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
VpcId() *string
SetVpcId(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnVpcConnection := awscdk.Aws_msk.NewCfnVpcConnection(this, jsii.String("MyCfnVpcConnection"), &CfnVpcConnectionProps{
Authentication: jsii.String("authentication"),
ClientSubnets: []*string{
jsii.String("clientSubnets"),
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
TargetClusterArn: jsii.String("targetClusterArn"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html
func NewCfnVpcConnection ¶ added in v2.78.0
func NewCfnVpcConnection(scope constructs.Construct, id *string, props *CfnVpcConnectionProps) CfnVpcConnection
type CfnVpcConnectionProps ¶ added in v2.78.0
type CfnVpcConnectionProps struct {
// The type of private link authentication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-authentication
//
Authentication *string `field:"required" json:"authentication" yaml:"authentication"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-clientsubnets
//
ClientSubnets *[]*string `field:"required" json:"clientSubnets" yaml:"clientSubnets"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-securitygroups
//
SecurityGroups *[]*string `field:"required" json:"securityGroups" yaml:"securityGroups"`
// The Amazon Resource Name (ARN) of the target cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-targetclusterarn
//
TargetClusterArn *string `field:"required" json:"targetClusterArn" yaml:"targetClusterArn"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// A key-value pair to associate with a resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html#cfn-msk-vpcconnection-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVpcConnection`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnVpcConnectionProps := &CfnVpcConnectionProps{
Authentication: jsii.String("authentication"),
ClientSubnets: []*string{
jsii.String("clientSubnets"),
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
TargetClusterArn: jsii.String("targetClusterArn"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html
Source Files
¶
- CfnBatchScramSecret.go
- CfnBatchScramSecretProps.go
- CfnBatchScramSecret__checks.go
- CfnCluster.go
- CfnClusterPolicy.go
- CfnClusterPolicyProps.go
- CfnClusterPolicy__checks.go
- CfnClusterProps.go
- CfnCluster_BrokerLogsProperty.go
- CfnCluster_BrokerNodeGroupInfoProperty.go
- CfnCluster_ClientAuthenticationProperty.go
- CfnCluster_CloudWatchLogsProperty.go
- CfnCluster_ConfigurationInfoProperty.go
- CfnCluster_ConnectivityInfoProperty.go
- CfnCluster_EBSStorageInfoProperty.go
- CfnCluster_EncryptionAtRestProperty.go
- CfnCluster_EncryptionInTransitProperty.go
- CfnCluster_EncryptionInfoProperty.go
- CfnCluster_FirehoseProperty.go
- CfnCluster_IamProperty.go
- CfnCluster_JmxExporterProperty.go
- CfnCluster_LoggingInfoProperty.go
- CfnCluster_NodeExporterProperty.go
- CfnCluster_OpenMonitoringProperty.go
- CfnCluster_PrometheusProperty.go
- CfnCluster_ProvisionedThroughputProperty.go
- CfnCluster_PublicAccessProperty.go
- CfnCluster_S3Property.go
- CfnCluster_SaslProperty.go
- CfnCluster_ScramProperty.go
- CfnCluster_StorageInfoProperty.go
- CfnCluster_TlsProperty.go
- CfnCluster_UnauthenticatedProperty.go
- CfnCluster_VpcConnectivityClientAuthenticationProperty.go
- CfnCluster_VpcConnectivityIamProperty.go
- CfnCluster_VpcConnectivityProperty.go
- CfnCluster_VpcConnectivitySaslProperty.go
- CfnCluster_VpcConnectivityScramProperty.go
- CfnCluster_VpcConnectivityTlsProperty.go
- CfnCluster__checks.go
- CfnConfiguration.go
- CfnConfigurationProps.go
- CfnConfiguration_LatestRevisionProperty.go
- CfnConfiguration__checks.go
- CfnReplicator.go
- CfnReplicatorProps.go
- CfnReplicator_AmazonMskClusterProperty.go
- CfnReplicator_ConsumerGroupReplicationProperty.go
- CfnReplicator_KafkaClusterClientVpcConfigProperty.go
- CfnReplicator_KafkaClusterProperty.go
- CfnReplicator_ReplicationInfoProperty.go
- CfnReplicator_ReplicationStartingPositionProperty.go
- CfnReplicator_ReplicationTopicNameConfigurationProperty.go
- CfnReplicator_TopicReplicationProperty.go
- CfnReplicator__checks.go
- CfnServerlessCluster.go
- CfnServerlessClusterProps.go
- CfnServerlessCluster_ClientAuthenticationProperty.go
- CfnServerlessCluster_IamProperty.go
- CfnServerlessCluster_SaslProperty.go
- CfnServerlessCluster_VpcConfigProperty.go
- CfnServerlessCluster__checks.go
- CfnVpcConnection.go
- CfnVpcConnectionProps.go
- CfnVpcConnection__checks.go
- main.go