Documentation
¶
Index ¶
- func CfnAccessPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAccessPolicy_IsCfnElement(x interface{}) *bool
- func CfnAccessPolicy_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAccessPolicy_IsConstruct(x interface{}) *bool
- func CfnCollection_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCollection_IsCfnElement(x interface{}) *bool
- func CfnCollection_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCollection_IsConstruct(x interface{}) *bool
- func CfnSecurityConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityConfig_IsCfnElement(x interface{}) *bool
- func CfnSecurityConfig_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSecurityConfig_IsConstruct(x interface{}) *bool
- func CfnSecurityPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityPolicy_IsCfnElement(x interface{}) *bool
- func CfnSecurityPolicy_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSecurityPolicy_IsConstruct(x interface{}) *bool
- func CfnVpcEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVpcEndpoint_IsCfnElement(x interface{}) *bool
- func CfnVpcEndpoint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVpcEndpoint_IsConstruct(x interface{}) *bool
- func NewCfnAccessPolicy_Override(c CfnAccessPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnCollection_Override(c CfnCollection, scope constructs.Construct, id *string, ...)
- func NewCfnSecurityConfig_Override(c CfnSecurityConfig, scope constructs.Construct, id *string, ...)
- func NewCfnSecurityPolicy_Override(c CfnSecurityPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnVpcEndpoint_Override(c CfnVpcEndpoint, scope constructs.Construct, id *string, ...)
- type CfnAccessPolicy
- type CfnAccessPolicyProps
- type CfnCollection
- type CfnCollectionProps
- type CfnSecurityConfig
- type CfnSecurityConfigProps
- type CfnSecurityConfig_SamlConfigOptionsProperty
- type CfnSecurityPolicy
- type CfnSecurityPolicyProps
- type CfnVpcEndpoint
- type CfnVpcEndpointProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAccessPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnAccessPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnAccessPolicy_IsCfnElement ¶
func CfnAccessPolicy_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 CfnAccessPolicy_IsCfnResource ¶
func CfnAccessPolicy_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnAccessPolicy_IsConstruct ¶
func CfnAccessPolicy_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 CfnCollection_CFN_RESOURCE_TYPE_NAME ¶
func CfnCollection_CFN_RESOURCE_TYPE_NAME() *string
func CfnCollection_IsCfnElement ¶
func CfnCollection_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 CfnCollection_IsCfnResource ¶
func CfnCollection_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCollection_IsConstruct ¶
func CfnCollection_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 CfnSecurityConfig_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityConfig_IsCfnElement ¶
func CfnSecurityConfig_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 CfnSecurityConfig_IsCfnResource ¶
func CfnSecurityConfig_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSecurityConfig_IsConstruct ¶
func CfnSecurityConfig_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 CfnSecurityPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityPolicy_IsCfnElement ¶
func CfnSecurityPolicy_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 CfnSecurityPolicy_IsCfnResource ¶
func CfnSecurityPolicy_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSecurityPolicy_IsConstruct ¶
func CfnSecurityPolicy_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 CfnVpcEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnVpcEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcEndpoint_IsCfnElement ¶
func CfnVpcEndpoint_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 CfnVpcEndpoint_IsCfnResource ¶
func CfnVpcEndpoint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnVpcEndpoint_IsConstruct ¶
func CfnVpcEndpoint_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 NewCfnAccessPolicy_Override ¶
func NewCfnAccessPolicy_Override(c CfnAccessPolicy, scope constructs.Construct, id *string, props *CfnAccessPolicyProps)
Create a new `AWS::OpenSearchServerless::AccessPolicy`.
func NewCfnCollection_Override ¶
func NewCfnCollection_Override(c CfnCollection, scope constructs.Construct, id *string, props *CfnCollectionProps)
Create a new `AWS::OpenSearchServerless::Collection`.
func NewCfnSecurityConfig_Override ¶
func NewCfnSecurityConfig_Override(c CfnSecurityConfig, scope constructs.Construct, id *string, props *CfnSecurityConfigProps)
Create a new `AWS::OpenSearchServerless::SecurityConfig`.
func NewCfnSecurityPolicy_Override ¶
func NewCfnSecurityPolicy_Override(c CfnSecurityPolicy, scope constructs.Construct, id *string, props *CfnSecurityPolicyProps)
Create a new `AWS::OpenSearchServerless::SecurityPolicy`.
func NewCfnVpcEndpoint_Override ¶
func NewCfnVpcEndpoint_Override(c CfnVpcEndpoint, scope constructs.Construct, id *string, props *CfnVpcEndpointProps)
Create a new `AWS::OpenSearchServerless::VpcEndpoint`.
Types ¶
type CfnAccessPolicy ¶
type CfnAccessPolicy 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
// 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
// `AWS::OpenSearchServerless::AccessPolicy.Description`.
Description() *string
SetDescription(val *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
// `AWS::OpenSearchServerless::AccessPolicy.Name`.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// `AWS::OpenSearchServerless::AccessPolicy.Policy`.
Policy() *string
SetPolicy(val *string)
// 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
// `AWS::OpenSearchServerless::AccessPolicy.Type`.
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 can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
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)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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{})
}
A CloudFormation `AWS::OpenSearchServerless::AccessPolicy`.
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"
cfnAccessPolicy := awscdk.Aws_opensearchserverless.NewCfnAccessPolicy(this, jsii.String("MyCfnAccessPolicy"), &cfnAccessPolicyProps{
description: jsii.String("description"),
name: jsii.String("name"),
policy: jsii.String("policy"),
type: jsii.String("type"),
})
func NewCfnAccessPolicy ¶
func NewCfnAccessPolicy(scope constructs.Construct, id *string, props *CfnAccessPolicyProps) CfnAccessPolicy
Create a new `AWS::OpenSearchServerless::AccessPolicy`.
type CfnAccessPolicyProps ¶
type CfnAccessPolicyProps struct {
// `AWS::OpenSearchServerless::AccessPolicy.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::OpenSearchServerless::AccessPolicy.Name`.
Name *string `field:"optional" json:"name" yaml:"name"`
// `AWS::OpenSearchServerless::AccessPolicy.Policy`.
Policy *string `field:"optional" json:"policy" yaml:"policy"`
// `AWS::OpenSearchServerless::AccessPolicy.Type`.
Type *string `field:"optional" json:"type" yaml:"type"`
}
Properties for defining a `CfnAccessPolicy`.
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"
cfnAccessPolicyProps := &cfnAccessPolicyProps{
description: jsii.String("description"),
name: jsii.String("name"),
policy: jsii.String("policy"),
type: jsii.String("type"),
}
type CfnCollection ¶
type CfnCollection interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrCollectionEndpoint() *string
AttrDashboardEndpoint() *string
AttrId() *string
// 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
// `AWS::OpenSearchServerless::Collection.Description`.
Description() *string
SetDescription(val *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
// `AWS::OpenSearchServerless::Collection.Name`.
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
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// `AWS::OpenSearchServerless::Collection.Tags`.
Tags() awscdk.TagManager
// `AWS::OpenSearchServerless::Collection.Type`.
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 can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
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)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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{})
}
A CloudFormation `AWS::OpenSearchServerless::Collection`.
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"
cfnCollection := awscdk.Aws_opensearchserverless.NewCfnCollection(this, jsii.String("MyCfnCollection"), &cfnCollectionProps{
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
type: jsii.String("type"),
})
func NewCfnCollection ¶
func NewCfnCollection(scope constructs.Construct, id *string, props *CfnCollectionProps) CfnCollection
Create a new `AWS::OpenSearchServerless::Collection`.
type CfnCollectionProps ¶
type CfnCollectionProps struct {
// `AWS::OpenSearchServerless::Collection.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `AWS::OpenSearchServerless::Collection.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::OpenSearchServerless::Collection.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// `AWS::OpenSearchServerless::Collection.Type`.
Type *string `field:"optional" json:"type" yaml:"type"`
}
Properties for defining a `CfnCollection`.
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"
cfnCollectionProps := &cfnCollectionProps{
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
type: jsii.String("type"),
}
type CfnSecurityConfig ¶
type CfnSecurityConfig interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// 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
// `AWS::OpenSearchServerless::SecurityConfig.Description`.
Description() *string
SetDescription(val *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
// `AWS::OpenSearchServerless::SecurityConfig.Name`.
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
// `AWS::OpenSearchServerless::SecurityConfig.SamlOptions`.
SamlOptions() interface{}
SetSamlOptions(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// `AWS::OpenSearchServerless::SecurityConfig.Type`.
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 can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
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)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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{})
}
A CloudFormation `AWS::OpenSearchServerless::SecurityConfig`.
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"
cfnSecurityConfig := awscdk.Aws_opensearchserverless.NewCfnSecurityConfig(this, jsii.String("MyCfnSecurityConfig"), &cfnSecurityConfigProps{
description: jsii.String("description"),
name: jsii.String("name"),
samlOptions: &samlConfigOptionsProperty{
metadata: jsii.String("metadata"),
// the properties below are optional
groupAttribute: jsii.String("groupAttribute"),
sessionTimeout: jsii.Number(123),
userAttribute: jsii.String("userAttribute"),
},
type: jsii.String("type"),
})
func NewCfnSecurityConfig ¶
func NewCfnSecurityConfig(scope constructs.Construct, id *string, props *CfnSecurityConfigProps) CfnSecurityConfig
Create a new `AWS::OpenSearchServerless::SecurityConfig`.
type CfnSecurityConfigProps ¶
type CfnSecurityConfigProps struct {
// `AWS::OpenSearchServerless::SecurityConfig.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::OpenSearchServerless::SecurityConfig.Name`.
Name *string `field:"optional" json:"name" yaml:"name"`
// `AWS::OpenSearchServerless::SecurityConfig.SamlOptions`.
SamlOptions interface{} `field:"optional" json:"samlOptions" yaml:"samlOptions"`
// `AWS::OpenSearchServerless::SecurityConfig.Type`.
Type *string `field:"optional" json:"type" yaml:"type"`
}
Properties for defining a `CfnSecurityConfig`.
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"
cfnSecurityConfigProps := &cfnSecurityConfigProps{
description: jsii.String("description"),
name: jsii.String("name"),
samlOptions: &samlConfigOptionsProperty{
metadata: jsii.String("metadata"),
// the properties below are optional
groupAttribute: jsii.String("groupAttribute"),
sessionTimeout: jsii.Number(123),
userAttribute: jsii.String("userAttribute"),
},
type: jsii.String("type"),
}
type CfnSecurityConfig_SamlConfigOptionsProperty ¶
type CfnSecurityConfig_SamlConfigOptionsProperty struct {
// `CfnSecurityConfig.SamlConfigOptionsProperty.Metadata`.
Metadata *string `field:"required" json:"metadata" yaml:"metadata"`
// `CfnSecurityConfig.SamlConfigOptionsProperty.GroupAttribute`.
GroupAttribute *string `field:"optional" json:"groupAttribute" yaml:"groupAttribute"`
// `CfnSecurityConfig.SamlConfigOptionsProperty.SessionTimeout`.
SessionTimeout *float64 `field:"optional" json:"sessionTimeout" yaml:"sessionTimeout"`
// `CfnSecurityConfig.SamlConfigOptionsProperty.UserAttribute`.
UserAttribute *string `field:"optional" json:"userAttribute" yaml:"userAttribute"`
}
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"
samlConfigOptionsProperty := &samlConfigOptionsProperty{
metadata: jsii.String("metadata"),
// the properties below are optional
groupAttribute: jsii.String("groupAttribute"),
sessionTimeout: jsii.Number(123),
userAttribute: jsii.String("userAttribute"),
}
type CfnSecurityPolicy ¶
type CfnSecurityPolicy 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
// 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
// `AWS::OpenSearchServerless::SecurityPolicy.Description`.
Description() *string
SetDescription(val *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
// `AWS::OpenSearchServerless::SecurityPolicy.Name`.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// `AWS::OpenSearchServerless::SecurityPolicy.Policy`.
Policy() *string
SetPolicy(val *string)
// 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
// `AWS::OpenSearchServerless::SecurityPolicy.Type`.
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 can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
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)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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{})
}
A CloudFormation `AWS::OpenSearchServerless::SecurityPolicy`.
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"
cfnSecurityPolicy := awscdk.Aws_opensearchserverless.NewCfnSecurityPolicy(this, jsii.String("MyCfnSecurityPolicy"), &cfnSecurityPolicyProps{
policy: jsii.String("policy"),
// the properties below are optional
description: jsii.String("description"),
name: jsii.String("name"),
type: jsii.String("type"),
})
func NewCfnSecurityPolicy ¶
func NewCfnSecurityPolicy(scope constructs.Construct, id *string, props *CfnSecurityPolicyProps) CfnSecurityPolicy
Create a new `AWS::OpenSearchServerless::SecurityPolicy`.
type CfnSecurityPolicyProps ¶
type CfnSecurityPolicyProps struct {
// `AWS::OpenSearchServerless::SecurityPolicy.Policy`.
Policy *string `field:"required" json:"policy" yaml:"policy"`
// `AWS::OpenSearchServerless::SecurityPolicy.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::OpenSearchServerless::SecurityPolicy.Name`.
Name *string `field:"optional" json:"name" yaml:"name"`
// `AWS::OpenSearchServerless::SecurityPolicy.Type`.
Type *string `field:"optional" json:"type" yaml:"type"`
}
Properties for defining a `CfnSecurityPolicy`.
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"
cfnSecurityPolicyProps := &cfnSecurityPolicyProps{
policy: jsii.String("policy"),
// the properties below are optional
description: jsii.String("description"),
name: jsii.String("name"),
type: jsii.String("type"),
}
type CfnVpcEndpoint ¶
type CfnVpcEndpoint interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// 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 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
// `AWS::OpenSearchServerless::VpcEndpoint.Name`.
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
// `AWS::OpenSearchServerless::VpcEndpoint.SecurityGroupIds`.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// `AWS::OpenSearchServerless::VpcEndpoint.SubnetIds`.
SubnetIds() *[]*string
SetSubnetIds(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{}
// `AWS::OpenSearchServerless::VpcEndpoint.VpcId`.
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.
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)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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{})
}
A CloudFormation `AWS::OpenSearchServerless::VpcEndpoint`.
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"
cfnVpcEndpoint := awscdk.Aws_opensearchserverless.NewCfnVpcEndpoint(this, jsii.String("MyCfnVpcEndpoint"), &cfnVpcEndpointProps{
name: jsii.String("name"),
vpcId: jsii.String("vpcId"),
// the properties below are optional
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
subnetIds: []*string{
jsii.String("subnetIds"),
},
})
func NewCfnVpcEndpoint ¶
func NewCfnVpcEndpoint(scope constructs.Construct, id *string, props *CfnVpcEndpointProps) CfnVpcEndpoint
Create a new `AWS::OpenSearchServerless::VpcEndpoint`.
type CfnVpcEndpointProps ¶
type CfnVpcEndpointProps struct {
// `AWS::OpenSearchServerless::VpcEndpoint.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `AWS::OpenSearchServerless::VpcEndpoint.VpcId`.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// `AWS::OpenSearchServerless::VpcEndpoint.SecurityGroupIds`.
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// `AWS::OpenSearchServerless::VpcEndpoint.SubnetIds`.
SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
}
Properties for defining a `CfnVpcEndpoint`.
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"
cfnVpcEndpointProps := &cfnVpcEndpointProps{
name: jsii.String("name"),
vpcId: jsii.String("vpcId"),
// the properties below are optional
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
subnetIds: []*string{
jsii.String("subnetIds"),
},
}
Source Files
¶
- awsopensearchserverless.go
- awsopensearchserverless_CfnAccessPolicy.go
- awsopensearchserverless_CfnAccessPolicyProps.go
- awsopensearchserverless_CfnAccessPolicy__runtime_type_checks.go
- awsopensearchserverless_CfnCollection.go
- awsopensearchserverless_CfnCollectionProps.go
- awsopensearchserverless_CfnCollection__runtime_type_checks.go
- awsopensearchserverless_CfnSecurityConfig.go
- awsopensearchserverless_CfnSecurityConfigProps.go
- awsopensearchserverless_CfnSecurityConfig_SamlConfigOptionsProperty.go
- awsopensearchserverless_CfnSecurityConfig__runtime_type_checks.go
- awsopensearchserverless_CfnSecurityPolicy.go
- awsopensearchserverless_CfnSecurityPolicyProps.go
- awsopensearchserverless_CfnSecurityPolicy__runtime_type_checks.go
- awsopensearchserverless_CfnVpcEndpoint.go
- awsopensearchserverless_CfnVpcEndpointProps.go
- awsopensearchserverless_CfnVpcEndpoint__runtime_type_checks.go