Documentation
¶
Index ¶
- func CfnDiscoverer_ArnForDiscoverer(resource interfacesawseventschemas.IDiscovererRef) *string
- func CfnDiscoverer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDiscoverer_IsCfnDiscoverer(x interface{}) *bool
- func CfnDiscoverer_IsCfnElement(x interface{}) *bool
- func CfnDiscoverer_IsCfnResource(x interface{}) *bool
- func CfnDiscoverer_IsConstruct(x interface{}) *bool
- func CfnRegistryPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRegistryPolicy_IsCfnElement(x interface{}) *bool
- func CfnRegistryPolicy_IsCfnRegistryPolicy(x interface{}) *bool
- func CfnRegistryPolicy_IsCfnResource(x interface{}) *bool
- func CfnRegistryPolicy_IsConstruct(x interface{}) *bool
- func CfnRegistry_ArnForRegistry(resource interfacesawseventschemas.IRegistryRef) *string
- func CfnRegistry_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRegistry_IsCfnElement(x interface{}) *bool
- func CfnRegistry_IsCfnRegistry(x interface{}) *bool
- func CfnRegistry_IsCfnResource(x interface{}) *bool
- func CfnRegistry_IsConstruct(x interface{}) *bool
- func CfnSchema_ArnForSchema(resource interfacesawseventschemas.ISchemaRef) *string
- func CfnSchema_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchema_IsCfnElement(x interface{}) *bool
- func CfnSchema_IsCfnResource(x interface{}) *bool
- func CfnSchema_IsCfnSchema(x interface{}) *bool
- func CfnSchema_IsConstruct(x interface{}) *bool
- func NewCfnDiscoverer_Override(c CfnDiscoverer, scope constructs.Construct, id *string, ...)
- func NewCfnRegistryPolicy_Override(c CfnRegistryPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnRegistry_Override(c CfnRegistry, scope constructs.Construct, id *string, props *CfnRegistryProps)
- func NewCfnSchema_Override(c CfnSchema, scope constructs.Construct, id *string, props *CfnSchemaProps)
- type CfnDiscoverer
- type CfnDiscovererProps
- type CfnDiscoverer_TagsEntryProperty
- type CfnRegistry
- type CfnRegistryPolicy
- type CfnRegistryPolicyProps
- type CfnRegistryProps
- type CfnRegistry_TagsEntryProperty
- type CfnSchema
- type CfnSchemaProps
- type CfnSchema_TagsEntryProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDiscoverer_ArnForDiscoverer ¶ added in v2.227.0
func CfnDiscoverer_ArnForDiscoverer(resource interfacesawseventschemas.IDiscovererRef) *string
func CfnDiscoverer_CFN_RESOURCE_TYPE_NAME ¶
func CfnDiscoverer_CFN_RESOURCE_TYPE_NAME() *string
func CfnDiscoverer_IsCfnDiscoverer ¶ added in v2.231.0
func CfnDiscoverer_IsCfnDiscoverer(x interface{}) *bool
Checks whether the given object is a CfnDiscoverer.
func CfnDiscoverer_IsCfnElement ¶
func CfnDiscoverer_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 CfnDiscoverer_IsCfnResource ¶
func CfnDiscoverer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDiscoverer_IsConstruct ¶
func CfnDiscoverer_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 CfnRegistryPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnRegistryPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnRegistryPolicy_IsCfnElement ¶
func CfnRegistryPolicy_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 CfnRegistryPolicy_IsCfnRegistryPolicy ¶ added in v2.231.0
func CfnRegistryPolicy_IsCfnRegistryPolicy(x interface{}) *bool
Checks whether the given object is a CfnRegistryPolicy.
func CfnRegistryPolicy_IsCfnResource ¶
func CfnRegistryPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRegistryPolicy_IsConstruct ¶
func CfnRegistryPolicy_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 CfnRegistry_ArnForRegistry ¶ added in v2.227.0
func CfnRegistry_ArnForRegistry(resource interfacesawseventschemas.IRegistryRef) *string
func CfnRegistry_CFN_RESOURCE_TYPE_NAME ¶
func CfnRegistry_CFN_RESOURCE_TYPE_NAME() *string
func CfnRegistry_IsCfnElement ¶
func CfnRegistry_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 CfnRegistry_IsCfnRegistry ¶ added in v2.231.0
func CfnRegistry_IsCfnRegistry(x interface{}) *bool
Checks whether the given object is a CfnRegistry.
func CfnRegistry_IsCfnResource ¶
func CfnRegistry_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRegistry_IsConstruct ¶
func CfnRegistry_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 CfnSchema_ArnForSchema ¶ added in v2.227.0
func CfnSchema_ArnForSchema(resource interfacesawseventschemas.ISchemaRef) *string
func CfnSchema_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchema_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchema_IsCfnElement ¶
func CfnSchema_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 CfnSchema_IsCfnResource ¶
func CfnSchema_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSchema_IsCfnSchema ¶ added in v2.231.0
func CfnSchema_IsCfnSchema(x interface{}) *bool
Checks whether the given object is a CfnSchema.
func CfnSchema_IsConstruct ¶
func CfnSchema_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 NewCfnDiscoverer_Override ¶
func NewCfnDiscoverer_Override(c CfnDiscoverer, scope constructs.Construct, id *string, props *CfnDiscovererProps)
Create a new `AWS::EventSchemas::Discoverer`.
func NewCfnRegistryPolicy_Override ¶
func NewCfnRegistryPolicy_Override(c CfnRegistryPolicy, scope constructs.Construct, id *string, props *CfnRegistryPolicyProps)
Create a new `AWS::EventSchemas::RegistryPolicy`.
func NewCfnRegistry_Override ¶
func NewCfnRegistry_Override(c CfnRegistry, scope constructs.Construct, id *string, props *CfnRegistryProps)
Create a new `AWS::EventSchemas::Registry`.
func NewCfnSchema_Override ¶
func NewCfnSchema_Override(c CfnSchema, scope constructs.Construct, id *string, props *CfnSchemaProps)
Create a new `AWS::EventSchemas::Schema`.
Types ¶
type CfnDiscoverer ¶
type CfnDiscoverer interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawseventschemas.IDiscovererRef
awscdk.ITaggable
AttrCrossAccount() awscdk.IResolvable
// The ARN of the discoverer.
AttrDiscovererArn() *string
// The ID of the discoverer.
AttrDiscovererId() *string
// The state of the discoverer.
AttrState() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// 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
// Allows for the discovery of the event schemas that are sent to the event bus from another account.
CrossAccount() interface{}
SetCrossAccount(val interface{})
// A description for the discoverer.
Description() *string
SetDescription(val *string)
// A reference to a Discoverer resource.
DiscovererRef() *interfacesawseventschemas.DiscovererReference
Env() *interfaces.ResourceEnvironment
// 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 ARN of the event bus.
SourceArn() *string
SetSourceArn(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
// Tags associated with the resource.
TagsRaw() *[]*CfnDiscoverer_TagsEntryProperty
SetTagsRaw(val *[]*CfnDiscoverer_TagsEntryProperty)
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Use the `AWS::EventSchemas::Discoverer` resource to specify a *discoverer* that is associated with an event bus.
A discoverer allows the Amazon EventBridge Schema Registry to automatically generate schemas based on events on an event bus.
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"
cfnDiscoverer := awscdk.Aws_eventschemas.NewCfnDiscoverer(this, jsii.String("MyCfnDiscoverer"), &CfnDiscovererProps{
SourceArn: jsii.String("sourceArn"),
// the properties below are optional
CrossAccount: jsii.Boolean(false),
Description: jsii.String("description"),
Tags: []TagsEntryProperty{
&TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnDiscoverer ¶
func NewCfnDiscoverer(scope constructs.Construct, id *string, props *CfnDiscovererProps) CfnDiscoverer
Create a new `AWS::EventSchemas::Discoverer`.
type CfnDiscovererProps ¶
type CfnDiscovererProps struct {
// The ARN of the event bus.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-sourcearn
//
SourceArn interface{} `field:"required" json:"sourceArn" yaml:"sourceArn"`
// Allows for the discovery of the event schemas that are sent to the event bus from another account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-crossaccount
//
// Default: - true.
//
CrossAccount interface{} `field:"optional" json:"crossAccount" yaml:"crossAccount"`
// A description for the discoverer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Tags associated with the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-discoverer.html#cfn-eventschemas-discoverer-tags
//
Tags *[]*CfnDiscoverer_TagsEntryProperty `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDiscoverer`.
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"
cfnDiscovererProps := &CfnDiscovererProps{
SourceArn: jsii.String("sourceArn"),
// the properties below are optional
CrossAccount: jsii.Boolean(false),
Description: jsii.String("description"),
Tags: []TagsEntryProperty{
&TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnDiscoverer_TagsEntryProperty ¶
type CfnDiscoverer_TagsEntryProperty struct {
// The key of a key-value pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html#cfn-eventschemas-discoverer-tagsentry-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// The value of a key-value pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-discoverer-tagsentry.html#cfn-eventschemas-discoverer-tagsentry-value
//
Value *string `field:"required" json:"value" yaml:"value"`
}
Tags to associate with the discoverer.
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"
tagsEntryProperty := &TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
type CfnRegistry ¶
type CfnRegistry interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawseventschemas.IRegistryRef
awscdk.ITaggable
// The ARN of the registry.
AttrRegistryArn() *string
// The name of the registry.
AttrRegistryName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// 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
// A description of the registry to be created.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// 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 name of the schema registry.
RegistryName() *string
SetRegistryName(val *string)
// A reference to a Registry resource.
RegistryRef() *interfacesawseventschemas.RegistryReference
// 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
// Tags to associate with the registry.
TagsRaw() *[]*CfnRegistry_TagsEntryProperty
SetTagsRaw(val *[]*CfnRegistry_TagsEntryProperty)
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Use the `AWS::EventSchemas::Registry` to specify a schema registry.
Schema registries are containers for Schemas. Registries collect and organize schemas so that your schemas are in logical groups.
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"
cfnRegistry := awscdk.Aws_eventschemas.NewCfnRegistry(this, jsii.String("MyCfnRegistry"), &CfnRegistryProps{
Description: jsii.String("description"),
RegistryName: jsii.String("registryName"),
Tags: []TagsEntryProperty{
&TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnRegistry ¶
func NewCfnRegistry(scope constructs.Construct, id *string, props *CfnRegistryProps) CfnRegistry
Create a new `AWS::EventSchemas::Registry`.
type CfnRegistryPolicy ¶
type CfnRegistryPolicy interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawseventschemas.IRegistryPolicyRef
// The ID of the policy.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// 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
Env() *interfaces.ResourceEnvironment
// 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
// A resource-based policy.
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 name of the registry.
RegistryName() *string
SetRegistryName(val *string)
// A reference to a RegistryPolicy resource.
RegistryPolicyRef() *interfacesawseventschemas.RegistryPolicyReference
// The revision ID of the policy.
RevisionId() *string
SetRevisionId(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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Use the `AWS::EventSchemas::RegistryPolicy` resource to specify resource-based policies for an EventBridge Schema Registry.
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{}
cfnRegistryPolicy := awscdk.Aws_eventschemas.NewCfnRegistryPolicy(this, jsii.String("MyCfnRegistryPolicy"), &CfnRegistryPolicyProps{
Policy: policy,
RegistryName: jsii.String("registryName"),
// the properties below are optional
RevisionId: jsii.String("revisionId"),
})
func NewCfnRegistryPolicy ¶
func NewCfnRegistryPolicy(scope constructs.Construct, id *string, props *CfnRegistryPolicyProps) CfnRegistryPolicy
Create a new `AWS::EventSchemas::RegistryPolicy`.
type CfnRegistryPolicyProps ¶
type CfnRegistryPolicyProps struct {
// A resource-based policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#cfn-eventschemas-registrypolicy-policy
//
Policy interface{} `field:"required" json:"policy" yaml:"policy"`
// The name of the registry.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#cfn-eventschemas-registrypolicy-registryname
//
RegistryName *string `field:"required" json:"registryName" yaml:"registryName"`
// The revision ID of the policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registrypolicy.html#cfn-eventschemas-registrypolicy-revisionid
//
RevisionId *string `field:"optional" json:"revisionId" yaml:"revisionId"`
}
Properties for defining a `CfnRegistryPolicy`.
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{}
cfnRegistryPolicyProps := &CfnRegistryPolicyProps{
Policy: policy,
RegistryName: jsii.String("registryName"),
// the properties below are optional
RevisionId: jsii.String("revisionId"),
}
type CfnRegistryProps ¶
type CfnRegistryProps struct {
// A description of the registry to be created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the schema registry.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-registryname
//
RegistryName interface{} `field:"optional" json:"registryName" yaml:"registryName"`
// Tags to associate with the registry.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-registry.html#cfn-eventschemas-registry-tags
//
Tags *[]*CfnRegistry_TagsEntryProperty `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRegistry`.
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"
cfnRegistryProps := &CfnRegistryProps{
Description: jsii.String("description"),
RegistryName: jsii.String("registryName"),
Tags: []TagsEntryProperty{
&TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnRegistry_TagsEntryProperty ¶
type CfnRegistry_TagsEntryProperty struct {
// The key of a key-value pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html#cfn-eventschemas-registry-tagsentry-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// The value of a key-value pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-registry-tagsentry.html#cfn-eventschemas-registry-tagsentry-value
//
Value *string `field:"required" json:"value" yaml:"value"`
}
Tags to associate with the schema registry.
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"
tagsEntryProperty := &TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
type CfnSchema ¶
type CfnSchema interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawseventschemas.ISchemaRef
awscdk.ITaggable
// The date and time that schema was modified.
AttrLastModified() *string
// The ARN of the schema.
AttrSchemaArn() *string
// The name of the schema.
AttrSchemaName() *string
// The version number of the schema.
AttrSchemaVersion() *string
// The date the schema version was created.
AttrVersionCreatedDate() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// The source of the schema definition.
Content() *string
SetContent(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
// A description of the schema.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// 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 name of the schema registry.
RegistryName() *string
SetRegistryName(val *string)
// The name of the schema.
SchemaName() *string
SetSchemaName(val *string)
// A reference to a Schema resource.
SchemaRef() *interfacesawseventschemas.SchemaReference
// 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
// Tags associated with the schema.
TagsRaw() *[]*CfnSchema_TagsEntryProperty
SetTagsRaw(val *[]*CfnSchema_TagsEntryProperty)
// The type of schema.
Type() *string
SetType(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{}
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Use the `AWS::EventSchemas::Schema` resource to specify an event schema.
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"
cfnSchema := awscdk.Aws_eventschemas.NewCfnSchema(this, jsii.String("MyCfnSchema"), &CfnSchemaProps{
Content: jsii.String("content"),
RegistryName: jsii.String("registryName"),
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
SchemaName: jsii.String("schemaName"),
Tags: []TagsEntryProperty{
&TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html
func NewCfnSchema ¶
func NewCfnSchema(scope constructs.Construct, id *string, props *CfnSchemaProps) CfnSchema
Create a new `AWS::EventSchemas::Schema`.
type CfnSchemaProps ¶
type CfnSchemaProps struct {
// The source of the schema definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-content
//
Content *string `field:"required" json:"content" yaml:"content"`
// The name of the schema registry.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-registryname
//
RegistryName *string `field:"required" json:"registryName" yaml:"registryName"`
// The type of schema.
//
// Valid types include `OpenApi3` and `JSONSchemaDraft4` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// A description of the schema.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the schema.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-schemaname
//
SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"`
// Tags associated with the schema.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-tags
//
Tags *[]*CfnSchema_TagsEntryProperty `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSchema`.
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"
cfnSchemaProps := &CfnSchemaProps{
Content: jsii.String("content"),
RegistryName: jsii.String("registryName"),
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
SchemaName: jsii.String("schemaName"),
Tags: []TagsEntryProperty{
&TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html
type CfnSchema_TagsEntryProperty ¶
type CfnSchema_TagsEntryProperty struct {
// The key of a key-value pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html#cfn-eventschemas-schema-tagsentry-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// The value of a key-value pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventschemas-schema-tagsentry.html#cfn-eventschemas-schema-tagsentry-value
//
Value *string `field:"required" json:"value" yaml:"value"`
}
Tags to associate with the schema.
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"
tagsEntryProperty := &TagsEntryProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
Source Files
¶
- CfnDiscoverer.go
- CfnDiscovererProps.go
- CfnDiscoverer_TagsEntryProperty.go
- CfnDiscoverer__checks.go
- CfnRegistry.go
- CfnRegistryPolicy.go
- CfnRegistryPolicyProps.go
- CfnRegistryPolicy__checks.go
- CfnRegistryProps.go
- CfnRegistry_TagsEntryProperty.go
- CfnRegistry__checks.go
- CfnSchema.go
- CfnSchemaProps.go
- CfnSchema_TagsEntryProperty.go
- CfnSchema__checks.go
- main.go