Skip to content

CustomResource

This class encapsulates and extends the ROS resource type ALIYUN::ROS::CustomResource, which is used to create a custom resource.

Initializers 

import com.aliyun.ros.cdk.ros.CustomResource;
CustomResource.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .serviceToken(java.lang.String)
    .serviceToken(IResolvable)
    .timeout(java.lang.Number)
    .timeout(IResolvable)
//  .httpConfig(IResolvable)
//  .httpConfig(HttpConfigProperty)
//  .parameters(IResolvable)
//  .parameters(java.util.Map<java.lang.String, java.lang.Object>)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
serviceToken java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceToken: The service token that was given to the template developer by the service provider to access the service.
timeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeout: Timeout seconds before service provider responses.
httpConfig com.aliyun.ros.cdk.core.IResolvable OR HttpConfigProperty Property httpConfig: Config for HTTP&HTTPS service provider.
parameters com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property parameters: Parameters to be passed to service provider.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

serviceTokenRequired

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

Property serviceToken: The service token that was given to the template developer by the service provider to access the service.

Allowed values:

  • Function Compute: acs:fc:::services//functions/
  • MNS Queue: acs:mns:::queues/ or acs:mns:::/queues/
  • MNS Topic: acs:mns:::topics/ or acs:mns:::/topics/

  • HTTP&HTTPS: web[options]: Two options are supported:

  • sync: sync HTTP&HTTPS request.

  • idempotent: indicates that the Create request is idempotent. Update and Delete requests should be always idempotent. Examples:
  • acs:fc:cn-hangzhou:123456789:services/test-service/functions/test-function
  • acs:mns:cn-hangzhou:123456789:queues/test-queue
  • acs:mns:cn-hangzhou:123456789:/queues/test-queue
  • acs:mns:cn-hangzhou:123456789:topics/test-topic
  • acs:mns:cn-hangzhou:123456789:/topics/test-topic
  • web:https://abc.com
  • web[sync]:http://abc.com
  • web[sync,idempotent]:https://abc.com

timeoutRequired

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

Property timeout: Timeout seconds before service provider responses.

It takes effects only if the type of ServiceToken is Function Compute, MNS Queue, MNS Topic or async HTTP&HTTPS request. Timeout seconds are always 10 for sync HTTP&HTTPS request.

httpConfigOptional

Property httpConfig: Config for HTTP&HTTPS service provider.

parametersOptional

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

Property parameters: Parameters to be passed to service provider.

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 

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.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • 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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.ros.CustomResource;
CustomResource.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrOutputs com.aliyun.ros.cdk.core.IResolvable Attribute Outputs: Output data received from service provider.

nodeRequired 

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

The construct tree node associated with this construct.

refRequired 

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

stackRequired 

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

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrOutputsRequired 

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

Attribute Outputs: Output data received from service provider.