alicloudroscdkelasticsearchserverless

package module
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

Aliyun ROS ELASTICSEARCHSERVERLESS Construct Library

This module is part of the AliCloud ROS Cloud Development Kit (ROS CDK) project.

import * as ELASTICSEARCHSERVERLESS from '@alicloud/ros-cdk-elasticsearchserverless';

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func App_IsConstruct

func App_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewApp_Override

func NewApp_Override(a App, scope alicloudroscdkcore.Construct, id *string, props *AppProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosApp_Override

func NewRosApp_Override(r RosApp, scope alicloudroscdkcore.Construct, id *string, props *RosAppProps, enableResourcePropertyConstraint *bool)

func RosApp_IsConstruct

func RosApp_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosApp_IsRosElement

func RosApp_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized 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 RosApp_IsRosResource

func RosApp_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosApp_ROS_RESOURCE_TYPE_NAME

func RosApp_ROS_RESOURCE_TYPE_NAME() *string

Types

type App

type App interface {
	alicloudroscdkcore.Resource
	IApp
	// Attribute InstanceId: The Id of the ElasticSearch serverless instance.
	AttrInstanceId() interface{}
	// Attribute PrivateESDomain: The private network domain of the app.
	AttrPrivateEsDomain() interface{}
	// Attribute PrivateKibanaDomain: The private network kibana domain of the app.
	AttrPrivateKibanaDomain() interface{}
	// Attribute PublicESDomain: The public network domain of the app.
	AttrPublicEsDomain() interface{}
	// Attribute PublicKibanaDomain: The public network kibana domain of the app.
	AttrPublicKibanaDomain() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() alicloudroscdkcore.IResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *AppProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::ElasticSearchServerless::App`, which is used to create an Elasticsearch serverless application.

func NewApp

func NewApp(scope alicloudroscdkcore.Construct, id *string, props *AppProps, enableResourcePropertyConstraint *bool) App

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type AppProps

type AppProps struct {
	// Property appName: The name of the elastic search serverless version app.
	AppName interface{} `field:"required" json:"appName" yaml:"appName"`
	// Property authentication: The authentication of the app.
	//
	// Currently only supports specifying passwords for initial users.
	Authentication interface{} `field:"required" json:"authentication" yaml:"authentication"`
	// Property quotaInfo: The quota info of the app.
	QuotaInfo interface{} `field:"required" json:"quotaInfo" yaml:"quotaInfo"`
	// Property appVersion: The version of the app.
	AppVersion interface{} `field:"optional" json:"appVersion" yaml:"appVersion"`
	// Property description: The description of the app.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property network: The public network of the app.
	Network interface{} `field:"optional" json:"network" yaml:"network"`
	// Property privateNetwork: The private network of the app.
	PrivateNetwork interface{} `field:"optional" json:"privateNetwork" yaml:"privateNetwork"`
}

Properties for defining a `App`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-elasticsearchserverless-app

type IApp added in v1.6.0

type IApp interface {
	alicloudroscdkcore.IResource
	// Attribute InstanceId: The Id of the ElasticSearch serverless instance.
	AttrInstanceId() interface{}
	// Attribute PrivateESDomain: The private network domain of the app.
	AttrPrivateEsDomain() interface{}
	// Attribute PrivateKibanaDomain: The private network kibana domain of the app.
	AttrPrivateKibanaDomain() interface{}
	// Attribute PublicESDomain: The public network domain of the app.
	AttrPublicEsDomain() interface{}
	// Attribute PublicKibanaDomain: The public network kibana domain of the app.
	AttrPublicKibanaDomain() interface{}
	Props() *AppProps
}

Represents a `App`.

type RosApp

type RosApp interface {
	alicloudroscdkcore.RosResource
	AppName() interface{}
	SetAppName(val interface{})
	AppVersion() interface{}
	SetAppVersion(val interface{})
	AttrInstanceId() alicloudroscdkcore.IResolvable
	AttrPrivateEsDomain() alicloudroscdkcore.IResolvable
	AttrPrivateKibanaDomain() alicloudroscdkcore.IResolvable
	AttrPublicEsDomain() alicloudroscdkcore.IResolvable
	AttrPublicKibanaDomain() alicloudroscdkcore.IResolvable
	Authentication() interface{}
	SetAuthentication(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	Description() interface{}
	SetDescription(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this 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
	Network() interface{}
	SetNetwork(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	PrivateNetwork() interface{}
	SetPrivateNetwork(val interface{})
	QuotaInfo() interface{}
	SetQuotaInfo(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ 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
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// 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{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count 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 alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS 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.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	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{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*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) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::ElasticSearchServerless::App`, which is used to create an Elasticsearch serverless application.

func NewRosApp

func NewRosApp(scope alicloudroscdkcore.Construct, id *string, props *RosAppProps, enableResourcePropertyConstraint *bool) RosApp

type RosAppProps

type RosAppProps struct {
	AppName        interface{} `field:"required" json:"appName" yaml:"appName"`
	Authentication interface{} `field:"required" json:"authentication" yaml:"authentication"`
	QuotaInfo      interface{} `field:"required" json:"quotaInfo" yaml:"quotaInfo"`
	AppVersion     interface{} `field:"optional" json:"appVersion" yaml:"appVersion"`
	Description    interface{} `field:"optional" json:"description" yaml:"description"`
	Network        interface{} `field:"optional" json:"network" yaml:"network"`
	PrivateNetwork interface{} `field:"optional" json:"privateNetwork" yaml:"privateNetwork"`
}

Properties for defining a `RosApp`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-elasticsearchserverless-app

type RosApp_AuthenticationProperty

type RosApp_AuthenticationProperty struct {
	BasicAuth interface{} `field:"required" json:"basicAuth" yaml:"basicAuth"`
}

type RosApp_BasicAuthProperty

type RosApp_BasicAuthProperty struct {
	Password interface{} `field:"required" json:"password" yaml:"password"`
}

type RosApp_NetworkProperty

type RosApp_NetworkProperty struct {
	Enabled      interface{} `field:"required" json:"enabled" yaml:"enabled"`
	Type         interface{} `field:"required" json:"type" yaml:"type"`
	WhiteIpGroup interface{} `field:"optional" json:"whiteIpGroup" yaml:"whiteIpGroup"`
}

type RosApp_PrivateNetworkProperty

type RosApp_PrivateNetworkProperty struct {
	Enabled       interface{} `field:"required" json:"enabled" yaml:"enabled"`
	PvlEndpointId interface{} `field:"required" json:"pvlEndpointId" yaml:"pvlEndpointId"`
	Type          interface{} `field:"required" json:"type" yaml:"type"`
	VpcId         interface{} `field:"required" json:"vpcId" yaml:"vpcId"`
	WhiteIpGroup  interface{} `field:"optional" json:"whiteIpGroup" yaml:"whiteIpGroup"`
}

type RosApp_PrivateNetworkWhiteIpGroupProperty

type RosApp_PrivateNetworkWhiteIpGroupProperty struct {
	GroupName interface{} `field:"required" json:"groupName" yaml:"groupName"`
	Ips       interface{} `field:"optional" json:"ips" yaml:"ips"`
}

type RosApp_QuotaInfoProperty

type RosApp_QuotaInfoProperty struct {
	AppType interface{} `field:"required" json:"appType" yaml:"appType"`
	Cu      interface{} `field:"required" json:"cu" yaml:"cu"`
	Storage interface{} `field:"required" json:"storage" yaml:"storage"`
}

type RosApp_WhiteIpGroupProperty

type RosApp_WhiteIpGroupProperty struct {
	GroupName interface{} `field:"required" json:"groupName" yaml:"groupName"`
	Ips       interface{} `field:"optional" json:"ips" yaml:"ips"`
}

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL