Skip to content

RosApi

This class is a base encapsulation around the ROS resource type ALIYUN::ApiGateway::Api, which is used to create an API.

Initializers 

import com.aliyun.ros.cdk.apigateway.RosApi;
RosApi.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .apiName(java.lang.String)
    .apiName(IResolvable)
    .groupId(java.lang.String)
    .groupId(IResolvable)
    .requestConfig(IResolvable)
    .requestConfig(RequestConfigProperty)
    .serviceConfig(IResolvable)
    .serviceConfig(ServiceConfigProperty)
    .visibility(java.lang.String)
    .visibility(IResolvable)
//  .allowSignatureMethod(java.lang.String)
//  .allowSignatureMethod(IResolvable)
//  .appCodeAuthType(java.lang.String)
//  .appCodeAuthType(IResolvable)
//  .authType(java.lang.String)
//  .authType(IResolvable)
//  .constParameters(IResolvable)
//  .constParameters(java.util.List<IResolvable)
//  .constParameters(ConstParametersProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableInternet(java.lang.Boolean)
//  .disableInternet(IResolvable)
//  .errorCodeSamples(IResolvable)
//  .errorCodeSamples(java.util.List<IResolvable)
//  .errorCodeSamples(ErrorCodeSamplesProperty>)
//  .failResultSample(java.lang.String)
//  .failResultSample(IResolvable)
//  .forceNonceCheck(java.lang.Boolean)
//  .forceNonceCheck(IResolvable)
//  .openIdConnectConfig(IResolvable)
//  .openIdConnectConfig(OpenIdConnectConfigProperty)
//  .requestParameters(IResolvable)
//  .requestParameters(java.util.List<IResolvable)
//  .requestParameters(RequestParametersProperty>)
//  .resultBodyModel(java.lang.String)
//  .resultBodyModel(IResolvable)
//  .resultDescriptions(java.lang.String)
//  .resultDescriptions(IResolvable)
//  .resultSample(java.lang.String)
//  .resultSample(IResolvable)
//  .resultType(java.lang.String)
//  .resultType(IResolvable)
//  .serviceParameters(IResolvable)
//  .serviceParameters(java.util.List<IResolvable)
//  .serviceParameters(ServiceParametersProperty>)
//  .serviceParametersMap(IResolvable)
//  .serviceParametersMap(java.util.List<IResolvable)
//  .serviceParametersMap(ServiceParametersMapProperty>)
//  .systemParameters(IResolvable)
//  .systemParameters(java.util.List<IResolvable)
//  .systemParameters(SystemParametersProperty>)
//  .tags(java.util.List<TagsProperty>)
//  .webSocketApiType(java.lang.String)
//  .webSocketApiType(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
apiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
groupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
requestConfig com.aliyun.ros.cdk.core.IResolvable OR RequestConfigProperty No description.
serviceConfig com.aliyun.ros.cdk.core.IResolvable OR ServiceConfigProperty No description.
visibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allowSignatureMethod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
appCodeAuthType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
authType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
constParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty> No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
disableInternet java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
errorCodeSamples com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty> No description.
failResultSample java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
forceNonceCheck java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
openIdConnectConfig com.aliyun.ros.cdk.core.IResolvable OR OpenIdConnectConfigProperty No description.
requestParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty> No description.
resultBodyModel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultDescriptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultSample java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty> No description.
serviceParametersMap com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty> No description.
systemParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty> No description.
tags java.util.List<TagsProperty> No description.
webSocketApiType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

scope in which this resource is defined.

idRequired

  • Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

apiNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

groupIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

requestConfigRequired

serviceConfigRequired

visibilityRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

allowSignatureMethodOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

appCodeAuthTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

authTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

constParametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty>

descriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

disableInternetOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

errorCodeSamplesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty>

failResultSampleOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

forceNonceCheckOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

openIdConnectConfigOptional

requestParametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty>

resultBodyModelOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultDescriptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultSampleOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

serviceParametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty>

serviceParametersMapOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty>

systemParametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty>

tagsOptional

webSocketApiTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public 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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.

addCondition 

public void addCondition(RosCondition con)

conRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDeletionOverride 

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.

addDependsOn 

public void addDependsOn(RosResource target)

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: com.aliyun.ros.cdk.core.RosResource

addDesc 

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData 

public void addMetaData(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

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: java.lang.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: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public void addPropertyDeletionOverride(java.lang.String propertyPath)

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

propertyPathRequired

  • Type: java.lang.String

The path to the property.

addPropertyOverride 

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

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

propertyPathRequired

  • Type: java.lang.String

The path of the property.

valueRequired

  • Type: java.lang.Object

The value.

addRosDependency 

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

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

policyOptional

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

optionsOptional

  • Type: com.aliyun.ros.cdk.core.RemovalPolicyOptions

getAtt 

public Reference getAtt(java.lang.String attributeName)

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: java.lang.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 com.aliyun.ros.cdk.apigateway.RosApi;
RosApi.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.apigateway.RosApi;
RosApi.isRosElement(java.lang.Object x)

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: java.lang.Object

isRosResource 

import com.aliyun.ros.cdk.apigateway.RosApi;
RosApi.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

  • Type: com.aliyun.ros.cdk.core.IConstruct

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrApiId com.aliyun.ros.cdk.core.IResolvable No description.
apiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
groupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
requestConfig com.aliyun.ros.cdk.core.IResolvable OR RequestConfigProperty No description.
serviceConfig com.aliyun.ros.cdk.core.IResolvable OR ServiceConfigProperty No description.
visibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allowSignatureMethod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
appCodeAuthType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
authType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
constParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty> No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
disableInternet java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
errorCodeSamples com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty> No description.
failResultSample java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
forceNonceCheck java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
openIdConnectConfig com.aliyun.ros.cdk.core.IResolvable OR OpenIdConnectConfigProperty No description.
requestParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty> No description.
resultBodyModel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultDescriptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultSample java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty> No description.
serviceParametersMap com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty> No description.
systemParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty> No description.
tags java.util.List<TagsProperty> No description.
webSocketApiType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

creationStackRequired 

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired 

public java.lang.String getLogicalId();
  • Type: java.lang.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 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this element is defined.

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

refRequired 

public java.lang.String getRef();
  • Type: java.lang.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 

public IRosResourceOptions getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

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

rosResourceTypeRequired 

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.

attrApiIdRequired 

public IResolvable getAttrApiId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

apiNameRequired 

public java.lang.Object getApiName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

enableResourcePropertyConstraintRequired 

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

groupIdRequired 

public java.lang.Object getGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

requestConfigRequired 

public java.lang.Object getRequestConfig();

serviceConfigRequired 

public java.lang.Object getServiceConfig();

visibilityRequired 

public java.lang.Object getVisibility();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

allowSignatureMethodOptional 

public java.lang.Object getAllowSignatureMethod();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

appCodeAuthTypeOptional 

public java.lang.Object getAppCodeAuthType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

authTypeOptional 

public java.lang.Object getAuthType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

constParametersOptional 

public java.lang.Object getConstParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty>

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

disableInternetOptional 

public java.lang.Object getDisableInternet();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

errorCodeSamplesOptional 

public java.lang.Object getErrorCodeSamples();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty>

failResultSampleOptional 

public java.lang.Object getFailResultSample();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

forceNonceCheckOptional 

public java.lang.Object getForceNonceCheck();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

openIdConnectConfigOptional 

public java.lang.Object getOpenIdConnectConfig();

requestParametersOptional 

public java.lang.Object getRequestParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty>

resultBodyModelOptional 

public java.lang.Object getResultBodyModel();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultDescriptionsOptional 

public java.lang.Object getResultDescriptions();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultSampleOptional 

public java.lang.Object getResultSample();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultTypeOptional 

public java.lang.Object getResultType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

serviceParametersOptional 

public java.lang.Object getServiceParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty>

serviceParametersMapOptional 

public java.lang.Object getServiceParametersMap();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty>

systemParametersOptional 

public java.lang.Object getSystemParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty>

tagsOptional 

public java.util.List<TagsProperty> getTags();

webSocketApiTypeOptional 

public java.lang.Object getWebSocketApiType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.