Skip to content

ApiAttachment

This class encapsulates and extends the ROS resource type ALIYUN::APIG::ApiAttachment.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Apig;
new ApiAttachment(Construct Scope, string Id, ApiAttachmentProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props ApiAttachmentProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • 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.
AddCondition No description.
AddCount No description.
AddDependency No description.
AddResourceDesc No description.
ApplyRemovalPolicy No description.
GetAtt No description.
SetMetadata No description.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Apig;
ApiAttachment.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrEnvironmentId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EnvironmentId: The ID of the environment to which the API is to deploy.
AttrHttpApiId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute HttpApiId: The ID of the HTTP API.
AttrRouteId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute RouteId: The route ID.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrEnvironmentIdRequired

public IResolvable AttrEnvironmentId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EnvironmentId: The ID of the environment to which the API is to deploy.


AttrHttpApiIdRequired

public IResolvable AttrHttpApiId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute HttpApiId: The ID of the HTTP API.


AttrRouteIdRequired

public IResolvable AttrRouteId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute RouteId: The route ID.

When publishing an HTTP API route, it must be passed in.