com.aliyun.ros.cdk.fc.Service Maven / Gradle / Ivy
package com.aliyun.ros.cdk.fc;
/**
* This class encapsulates and extends the ROS resource type ALIYUN::FC::Service, which is used to create a service in Function Compute.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-12-13T06:45:13.500Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.fc.$Module.class, fqn = "@alicloud/ros-cdk-fc.Service")
public class Service extends com.aliyun.ros.cdk.core.Resource {
protected Service(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Service(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
* @param enableResourcePropertyConstraint
*/
public Service(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.fc.ServiceProps props, final @org.jetbrains.annotations.Nullable java.lang.Boolean enableResourcePropertyConstraint) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required"), enableResourcePropertyConstraint });
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
public Service(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.fc.ServiceProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Attribute InternetAccess: Whether enable Internet access.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrInternetAccess() {
return software.amazon.jsii.Kernel.get(this, "attrInternetAccess", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute LogProject: Log project of service.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrLogProject() {
return software.amazon.jsii.Kernel.get(this, "attrLogProject", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute Logstore: Log store of service.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrLogstore() {
return software.amazon.jsii.Kernel.get(this, "attrLogstore", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute Role: Role of service.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrRole() {
return software.amazon.jsii.Kernel.get(this, "attrRole", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute ServiceId: The service ID.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrServiceId() {
return software.amazon.jsii.Kernel.get(this, "attrServiceId", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute ServiceName: The service name.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrServiceName() {
return software.amazon.jsii.Kernel.get(this, "attrServiceName", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute Tags: Tags of service.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrTags() {
return software.amazon.jsii.Kernel.get(this, "attrTags", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute VpcId: VPC ID.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrVpcId() {
return software.amazon.jsii.Kernel.get(this, "attrVpcId", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
protected @org.jetbrains.annotations.NotNull java.lang.Boolean getEnableResourcePropertyConstraint() {
return software.amazon.jsii.Kernel.get(this, "enableResourcePropertyConstraint", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
protected void setEnableResourcePropertyConstraint(final @org.jetbrains.annotations.NotNull java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "enableResourcePropertyConstraint", java.util.Objects.requireNonNull(value, "enableResourcePropertyConstraint is required"));
}
protected @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
protected void setId(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "id", java.util.Objects.requireNonNull(value, "id is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.fc.ServiceProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.fc.ServiceProps.class));
}
protected void setProps(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.fc.ServiceProps value) {
software.amazon.jsii.Kernel.set(this, "props", java.util.Objects.requireNonNull(value, "props is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.Construct.class));
}
protected void setScope(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct value) {
software.amazon.jsii.Kernel.set(this, "scope", java.util.Objects.requireNonNull(value, "scope is required"));
}
/**
* A fluent builder for {@link com.aliyun.ros.cdk.fc.Service}.
*/
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
* @param enableResourcePropertyConstraint
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
return new Builder(scope, id, enableResourcePropertyConstraint);
}
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id, null);
}
private final com.aliyun.ros.cdk.core.Construct scope;
private final java.lang.String id;
private final java.lang.Boolean enableResourcePropertyConstraint;
private final com.aliyun.ros.cdk.fc.ServiceProps.Builder props;
private Builder(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
this.scope = scope;
this.id = id;
this.enableResourcePropertyConstraint = enableResourcePropertyConstraint;
this.props = new com.aliyun.ros.cdk.fc.ServiceProps.Builder();
}
/**
* Property serviceName: Service name.
*
* @return {@code this}
* @param serviceName Property serviceName: Service name. This parameter is required.
*/
public Builder serviceName(final java.lang.String serviceName) {
this.props.serviceName(serviceName);
return this;
}
/**
* Property serviceName: Service name.
*
* @return {@code this}
* @param serviceName Property serviceName: Service name. This parameter is required.
*/
public Builder serviceName(final com.aliyun.ros.cdk.core.IResolvable serviceName) {
this.props.serviceName(serviceName);
return this;
}
/**
* Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.
*
* Default value is false.
*
* @return {@code this}
* @param deletionForce Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified. This parameter is required.
*/
public Builder deletionForce(final java.lang.Boolean deletionForce) {
this.props.deletionForce(deletionForce);
return this;
}
/**
* Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.
*
* Default value is false.
*
* @return {@code this}
* @param deletionForce Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified. This parameter is required.
*/
public Builder deletionForce(final com.aliyun.ros.cdk.core.IResolvable deletionForce) {
this.props.deletionForce(deletionForce);
return this;
}
/**
* Property description: Service description.
*
* @return {@code this}
* @param description Property description: Service description. This parameter is required.
*/
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* Property description: Service description.
*
* @return {@code this}
* @param description Property description: Service description. This parameter is required.
*/
public Builder description(final com.aliyun.ros.cdk.core.IResolvable description) {
this.props.description(description);
return this;
}
/**
* Property internetAccess: Set it to true to enable Internet access.
*
* @return {@code this}
* @param internetAccess Property internetAccess: Set it to true to enable Internet access. This parameter is required.
*/
public Builder internetAccess(final java.lang.Boolean internetAccess) {
this.props.internetAccess(internetAccess);
return this;
}
/**
* Property internetAccess: Set it to true to enable Internet access.
*
* @return {@code this}
* @param internetAccess Property internetAccess: Set it to true to enable Internet access. This parameter is required.
*/
public Builder internetAccess(final com.aliyun.ros.cdk.core.IResolvable internetAccess) {
this.props.internetAccess(internetAccess);
return this;
}
/**
* Property logConfig: Log configuration.
*
* Function Compute pushes function execution logs to the configured log store.
*
* @return {@code this}
* @param logConfig Property logConfig: Log configuration. This parameter is required.
*/
public Builder logConfig(final com.aliyun.ros.cdk.core.IResolvable logConfig) {
this.props.logConfig(logConfig);
return this;
}
/**
* Property logConfig: Log configuration.
*
* Function Compute pushes function execution logs to the configured log store.
*
* @return {@code this}
* @param logConfig Property logConfig: Log configuration. This parameter is required.
*/
public Builder logConfig(final com.aliyun.ros.cdk.fc.RosService.LogConfigProperty logConfig) {
this.props.logConfig(logConfig);
return this;
}
/**
* Property nasConfig: NAS configuration.
*
* Function Compute uses a specified NAS configured on the service.
*
* @return {@code this}
* @param nasConfig Property nasConfig: NAS configuration. This parameter is required.
*/
public Builder nasConfig(final com.aliyun.ros.cdk.core.IResolvable nasConfig) {
this.props.nasConfig(nasConfig);
return this;
}
/**
* Property nasConfig: NAS configuration.
*
* Function Compute uses a specified NAS configured on the service.
*
* @return {@code this}
* @param nasConfig Property nasConfig: NAS configuration. This parameter is required.
*/
public Builder nasConfig(final com.aliyun.ros.cdk.fc.RosService.NasConfigProperty nasConfig) {
this.props.nasConfig(nasConfig);
return this;
}
/**
* Property ossMountConfig: The OSS mount configurations.
*
* @return {@code this}
* @param ossMountConfig Property ossMountConfig: The OSS mount configurations. This parameter is required.
*/
public Builder ossMountConfig(final com.aliyun.ros.cdk.core.IResolvable ossMountConfig) {
this.props.ossMountConfig(ossMountConfig);
return this;
}
/**
* Property ossMountConfig: The OSS mount configurations.
*
* @return {@code this}
* @param ossMountConfig Property ossMountConfig: The OSS mount configurations. This parameter is required.
*/
public Builder ossMountConfig(final com.aliyun.ros.cdk.fc.RosService.OssMountConfigProperty ossMountConfig) {
this.props.ossMountConfig(ossMountConfig);
return this;
}
/**
* Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.
*
* The temporary STS token generated from this role can be retrieved from function context and used to access cloud resources.
*
* @return {@code this}
* @param role Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store. This parameter is required.
*/
public Builder role(final java.lang.String role) {
this.props.role(role);
return this;
}
/**
* Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.
*
* The temporary STS token generated from this role can be retrieved from function context and used to access cloud resources.
*
* @return {@code this}
* @param role Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store. This parameter is required.
*/
public Builder role(final com.aliyun.ros.cdk.core.IResolvable role) {
this.props.role(role);
return this;
}
/**
* Property tags: Tags to attach to service.
*
* Max support 20 tags to add during create service. Each tag with two properties Key and Value, and Key is required.
*
* @return {@code this}
* @param tags Property tags: Tags to attach to service. This parameter is required.
*/
public Builder tags(final java.util.List tags) {
this.props.tags(tags);
return this;
}
/**
* Property tracingConfig: The Tracing Analysis configuration.
*
* After Function Compute integrates with Tracing Analysis, you can record the stay time of a request in Function Compute, view the cold start time for a function, and record the execution time of a function.
*
* @return {@code this}
* @param tracingConfig Property tracingConfig: The Tracing Analysis configuration. This parameter is required.
*/
public Builder tracingConfig(final com.aliyun.ros.cdk.core.IResolvable tracingConfig) {
this.props.tracingConfig(tracingConfig);
return this;
}
/**
* Property tracingConfig: The Tracing Analysis configuration.
*
* After Function Compute integrates with Tracing Analysis, you can record the stay time of a request in Function Compute, view the cold start time for a function, and record the execution time of a function.
*
* @return {@code this}
* @param tracingConfig Property tracingConfig: The Tracing Analysis configuration. This parameter is required.
*/
public Builder tracingConfig(final com.aliyun.ros.cdk.fc.RosService.TracingConfigProperty tracingConfig) {
this.props.tracingConfig(tracingConfig);
return this;
}
/**
* Property vpcBindings: Function Invocation only by Specified VPCs.
*
* By default, you can invoke the function by using the Internet endpoint and internal endpoint after a function is created. If you want the function to be invoked only by using specified VPCs, but not the Internet endpoint or internal endpoint, you must bind the specified VPCs to the service.
*
* @return {@code this}
* @param vpcBindings Property vpcBindings: Function Invocation only by Specified VPCs. This parameter is required.
*/
public Builder vpcBindings(final com.aliyun.ros.cdk.core.IResolvable vpcBindings) {
this.props.vpcBindings(vpcBindings);
return this;
}
/**
* Property vpcBindings: Function Invocation only by Specified VPCs.
*
* By default, you can invoke the function by using the Internet endpoint and internal endpoint after a function is created. If you want the function to be invoked only by using specified VPCs, but not the Internet endpoint or internal endpoint, you must bind the specified VPCs to the service.
*
* @return {@code this}
* @param vpcBindings Property vpcBindings: Function Invocation only by Specified VPCs. This parameter is required.
*/
public Builder vpcBindings(final java.util.List vpcBindings) {
this.props.vpcBindings(vpcBindings);
return this;
}
/**
* Property vpcConfig: VPC configuration.
*
* Function Compute uses the config to setup ENI in the specific VPC.
*
* @return {@code this}
* @param vpcConfig Property vpcConfig: VPC configuration. This parameter is required.
*/
public Builder vpcConfig(final com.aliyun.ros.cdk.core.IResolvable vpcConfig) {
this.props.vpcConfig(vpcConfig);
return this;
}
/**
* Property vpcConfig: VPC configuration.
*
* Function Compute uses the config to setup ENI in the specific VPC.
*
* @return {@code this}
* @param vpcConfig Property vpcConfig: VPC configuration. This parameter is required.
*/
public Builder vpcConfig(final com.aliyun.ros.cdk.fc.RosService.VpcConfigProperty vpcConfig) {
this.props.vpcConfig(vpcConfig);
return this;
}
/**
* @return a newly built instance of {@link com.aliyun.ros.cdk.fc.Service}.
*/
@Override
public com.aliyun.ros.cdk.fc.Service build() {
return new com.aliyun.ros.cdk.fc.Service(
this.scope,
this.id,
this.props.build(),
this.enableResourcePropertyConstraint
);
}
}
}