Skip to content

RosApplication

This class is a base encapsulation around the ROS resource type ALIYUN::SAE::Application, which is used to create an application in Serverless App Engine (SAE).

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdksae"
alicloudroscdksae.NewRosApplication(scope Construct, id *string, props RosApplicationProps, enableResourcePropertyConstraint *bool) RosApplication
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct - scope in which this resource is defined.
id *string - scoped id of the resource.
props RosApplicationProps - resource properties.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

scope in which this resource is defined.


idRequired

  • Type: *string

scoped id of the resource.


propsRequired

resource properties.


enableResourcePropertyConstraintRequired

  • Type: *bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
AddCondition No description.
AddCount No description.
AddDeletionOverride Syntactic sugar for addOverride(path, undefined).
AddDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc No description.
AddMetaData No description.
AddOverride Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride Adds an override to a resource property.
AddRosDependency No description.
ApplyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
GetAtt Returns a token for an runtime attribute of this resource.

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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.

sessionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: *string

The new logical ID to use for this stack element.


AddCondition

func AddCondition(con RosCondition)

conRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: *string

The path of the value to delete.


AddDependsOn

func AddDependsOn(target RosResource)

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.

targetRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AddDesc

func AddDesc(desc *string)

descRequired

  • Type: *string

AddMetaData

func AddMetaData(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

AddOverride

func AddOverride(path *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,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: *string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: interface{}

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: *string

The path to the property.


AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: *string

The path of the property.


valueRequired

  • Type: interface{}

The value.


AddRosDependency

func AddRosDependency(target *string)

targetRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

optionsOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

GetAtt

func GetAtt(attributeName *string) Reference

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.

attributeNameRequired

  • Type: *string

The name of the attribute.


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource Check whether the given construct is a RosResource.

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdksae"
alicloudroscdksae.RosApplication_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdksae"
alicloudroscdksae.RosApplication_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.

xRequired

  • Type: interface{}

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdksae"
alicloudroscdksae.RosApplication_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

constructRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
CreationStack []string No description.
LogicalId *string The logical ID for this stack element.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this element is defined.
Ref *string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType *string ROS resource type.
AttrAppId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrChangeOrderId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AppName interface{} No description.
Cpu interface{} No description.
EnableResourcePropertyConstraint *bool No description.
Memory interface{} No description.
NamespaceId interface{} No description.
PackageType interface{} No description.
Replicas interface{} No description.
AcrAssumeRoleArn interface{} No description.
AcrInstanceId interface{} No description.
AppDescription interface{} No description.
AppSource interface{} No description.
AssociateEip interface{} No description.
AutoConfig interface{} No description.
BaseAppId interface{} No description.
Command interface{} No description.
CommandArgs interface{} No description.
ConfigMapMountDesc interface{} No description.
CustomHostAlias interface{} No description.
Deploy interface{} No description.
EdasContainerVersion interface{} No description.
EnableEbpf interface{} No description.
Envs interface{} No description.
ImagePullSecrets interface{} No description.
ImageUrl interface{} No description.
JarStartArgs interface{} No description.
JarStartOptions interface{} No description.
Jdk interface{} No description.
KafkaConfigs interface{} No description.
Liveness interface{} No description.
MicroRegistration interface{} No description.
MicroRegistrationConfig interface{} No description.
MountDesc interface{} No description.
MountHost interface{} No description.
NasConfigs interface{} No description.
NasId interface{} No description.
OssAkId interface{} No description.
OssAkSecret interface{} No description.
OssMountDescs interface{} No description.
PackageUrl interface{} No description.
PackageVersion interface{} No description.
Php interface{} No description.
PhpArmsConfigLocation interface{} No description.
PhpConfig interface{} No description.
PhpConfigLocation interface{} No description.
PostStart interface{} No description.
PreStop interface{} No description.
ProgrammingLanguage interface{} No description.
PvtzDiscoverySvc interface{} No description.
Python interface{} No description.
PythonModules interface{} No description.
Readiness interface{} No description.
SaeVersion interface{} No description.
SecurityGroupId interface{} No description.
ServiceTags interface{} No description.
SlsConfigs interface{} No description.
Tags *[]TagsProperty No description.
TerminationGracePeriodSeconds interface{} No description.
Timezone interface{} No description.
TomcatConfig interface{} No description.
VpcId interface{} No description.
VSwitchId interface{} No description.
WarStartOptions interface{} No description.
WebContainer interface{} No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

func CreationStack() *[]*string
  • Type: []string

LogicalIdRequired

func LogicalId() *string
  • Type: *string

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).


StackRequired

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

func Ref() *string
  • Type: *string

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 }).


RosOptionsRequired

func RosOptions() IRosResourceOptions
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

func RosResourceType() *string
  • Type: *string

ROS resource type.


AttrAppIdRequired

func AttrAppId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrChangeOrderIdRequired

func AttrChangeOrderId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AppNameRequired

func AppName() interface{}
  • Type: interface{}

CpuRequired

func Cpu() interface{}
  • Type: interface{}

EnableResourcePropertyConstraintRequired

func EnableResourcePropertyConstraint() *bool
  • Type: *bool

MemoryRequired

func Memory() interface{}
  • Type: interface{}

NamespaceIdRequired

func NamespaceId() interface{}
  • Type: interface{}

PackageTypeRequired

func PackageType() interface{}
  • Type: interface{}

ReplicasRequired

func Replicas() interface{}
  • Type: interface{}

AcrAssumeRoleArnOptional

func AcrAssumeRoleArn() interface{}
  • Type: interface{}

AcrInstanceIdOptional

func AcrInstanceId() interface{}
  • Type: interface{}

AppDescriptionOptional

func AppDescription() interface{}
  • Type: interface{}

AppSourceOptional

func AppSource() interface{}
  • Type: interface{}

AssociateEipOptional

func AssociateEip() interface{}
  • Type: interface{}

AutoConfigOptional

func AutoConfig() interface{}
  • Type: interface{}

BaseAppIdOptional

func BaseAppId() interface{}
  • Type: interface{}

CommandOptional

func Command() interface{}
  • Type: interface{}

CommandArgsOptional

func CommandArgs() interface{}
  • Type: interface{}

ConfigMapMountDescOptional

func ConfigMapMountDesc() interface{}
  • Type: interface{}

CustomHostAliasOptional

func CustomHostAlias() interface{}
  • Type: interface{}

DeployOptional

func Deploy() interface{}
  • Type: interface{}

EdasContainerVersionOptional

func EdasContainerVersion() interface{}
  • Type: interface{}

EnableEbpfOptional

func EnableEbpf() interface{}
  • Type: interface{}

EnvsOptional

func Envs() interface{}
  • Type: interface{}

ImagePullSecretsOptional

func ImagePullSecrets() interface{}
  • Type: interface{}

ImageUrlOptional

func ImageUrl() interface{}
  • Type: interface{}

JarStartArgsOptional

func JarStartArgs() interface{}
  • Type: interface{}

JarStartOptionsOptional

func JarStartOptions() interface{}
  • Type: interface{}

JdkOptional

func Jdk() interface{}
  • Type: interface{}

KafkaConfigsOptional

func KafkaConfigs() interface{}
  • Type: interface{}

LivenessOptional

func Liveness() interface{}
  • Type: interface{}

MicroRegistrationOptional

func MicroRegistration() interface{}
  • Type: interface{}

MicroRegistrationConfigOptional

func MicroRegistrationConfig() interface{}
  • Type: interface{}

MountDescOptional

func MountDesc() interface{}
  • Type: interface{}

MountHostOptional

func MountHost() interface{}
  • Type: interface{}

NasConfigsOptional

func NasConfigs() interface{}
  • Type: interface{}

NasIdOptional

func NasId() interface{}
  • Type: interface{}

OssAkIdOptional

func OssAkId() interface{}
  • Type: interface{}

OssAkSecretOptional

func OssAkSecret() interface{}
  • Type: interface{}

OssMountDescsOptional

func OssMountDescs() interface{}
  • Type: interface{}

PackageUrlOptional

func PackageUrl() interface{}
  • Type: interface{}

PackageVersionOptional

func PackageVersion() interface{}
  • Type: interface{}

PhpOptional

func Php() interface{}
  • Type: interface{}

PhpArmsConfigLocationOptional

func PhpArmsConfigLocation() interface{}
  • Type: interface{}

PhpConfigOptional

func PhpConfig() interface{}
  • Type: interface{}

PhpConfigLocationOptional

func PhpConfigLocation() interface{}
  • Type: interface{}

PostStartOptional

func PostStart() interface{}
  • Type: interface{}

PreStopOptional

func PreStop() interface{}
  • Type: interface{}

ProgrammingLanguageOptional

func ProgrammingLanguage() interface{}
  • Type: interface{}

PvtzDiscoverySvcOptional

func PvtzDiscoverySvc() interface{}
  • Type: interface{}

PythonOptional

func Python() interface{}
  • Type: interface{}

PythonModulesOptional

func PythonModules() interface{}
  • Type: interface{}

ReadinessOptional

func Readiness() interface{}
  • Type: interface{}

SaeVersionOptional

func SaeVersion() interface{}
  • Type: interface{}

SecurityGroupIdOptional

func SecurityGroupId() interface{}
  • Type: interface{}

ServiceTagsOptional

func ServiceTags() interface{}
  • Type: interface{}

SlsConfigsOptional

func SlsConfigs() interface{}
  • Type: interface{}

TagsOptional

func Tags() *[]TagsProperty

TerminationGracePeriodSecondsOptional

func TerminationGracePeriodSeconds() interface{}
  • Type: interface{}

TimezoneOptional

func Timezone() interface{}
  • Type: interface{}

TomcatConfigOptional

func TomcatConfig() interface{}
  • Type: interface{}

VpcIdOptional

func VpcId() interface{}
  • Type: interface{}

VSwitchIdOptional

func VSwitchId() interface{}
  • Type: interface{}

WarStartOptionsOptional

func WarStartOptions() interface{}
  • Type: interface{}

WebContainerOptional

func WebContainer() interface{}
  • Type: interface{}

Constants

Name Type Description
RosResourceTypeName *string The resource type name for this resource class.

RosResourceTypeNameRequired

func RosResourceTypeName() *string
  • Type: *string

The resource type name for this resource class.