Module types/input

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

namespace apigateway

interface ApiConstantParameter

interface ApiConstantParameter

property description

description?: pulumi.Input<string>;

The description of Constant parameter.

property in

in: pulumi.Input<string>;

System parameter location; values: ‘HEAD’ and ‘QUERY’.

property name

name: pulumi.Input<string>;

System parameter name which supports values including in system parameter list

property value

value: pulumi.Input<string>;

Constant parameter value.

interface ApiFcServiceConfig

interface ApiFcServiceConfig

property arnRole

arnRole?: pulumi.Input<string>;

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

property functionName

functionName: pulumi.Input<string>;

The function name of function compute service.

property region

region: pulumi.Input<string>;

The region that the function compute service belongs to.

property serviceName

serviceName: pulumi.Input<string>;

The service name of function compute service.

property timeout

timeout: pulumi.Input<number>;

Backend service time-out time; unit: millisecond.

interface ApiHttpServiceConfig

interface ApiHttpServiceConfig

property address

address: pulumi.Input<string>;

The address of backend service.

property aoneName

aoneName?: pulumi.Input<string>;

property method

method: pulumi.Input<string>;

The http method of backend service.

property path

path: pulumi.Input<string>;

The path of backend service.

property timeout

timeout: pulumi.Input<number>;

Backend service time-out time; unit: millisecond.

interface ApiHttpVpcServiceConfig

interface ApiHttpVpcServiceConfig

property aoneName

aoneName?: pulumi.Input<string>;

property method

method: pulumi.Input<string>;

The http method of backend service.

property name

name: pulumi.Input<string>;

System parameter name which supports values including in system parameter list

property path

path: pulumi.Input<string>;

The path of backend service.

property timeout

timeout: pulumi.Input<number>;

Backend service time-out time; unit: millisecond.

interface ApiMockServiceConfig

interface ApiMockServiceConfig

property aoneName

aoneName?: pulumi.Input<string>;

property result

result: pulumi.Input<string>;

The result of the mock service.

interface ApiRequestConfig

interface ApiRequestConfig

property bodyFormat

bodyFormat?: pulumi.Input<string>;

The body format of the api, which support the values of ‘STREAM’ and ‘FORM’

property method

method: pulumi.Input<string>;

The http method of backend service.

property mode

mode: pulumi.Input<string>;

The mode of the parameters between request parameters and service parameters, which support the values of ‘MAPPING’ and ‘PASSTHROUGH’

property path

path: pulumi.Input<string>;

The path of backend service.

property protocol

protocol: pulumi.Input<string>;

The protocol of api which supports values of ‘HTTP’,‘HTTPS’ or ‘HTTP,HTTPS’

interface ApiRequestParameter

interface ApiRequestParameter

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value of the parameter.

property description

description?: pulumi.Input<string>;

The description of Constant parameter.

property in

in: pulumi.Input<string>;

System parameter location; values: ‘HEAD’ and ‘QUERY’.

property inService

inService: pulumi.Input<string>;

Backend service’s parameter location; values: BODY, HEAD, QUERY, and PATH.

property name

name: pulumi.Input<string>;

System parameter name which supports values including in system parameter list

property nameService

nameService: pulumi.Input<string>;

Backend service’s parameter name.

property required

required: pulumi.Input<string>;

Parameter required or not; values: REQUIRED and OPTIONAL.

property type

type: pulumi.Input<string>;

Parameter type which supports values of ‘STRING’,‘INT’,‘BOOLEAN’,‘LONG’,“FLOAT” and “DOUBLE”

interface ApiSystemParameter

interface ApiSystemParameter

property in

in: pulumi.Input<string>;

System parameter location; values: ‘HEAD’ and ‘QUERY’.

property name

name: pulumi.Input<string>;

System parameter name which supports values including in system parameter list

property nameService

nameService: pulumi.Input<string>;

Backend service’s parameter name.

namespace cdn

interface DomainAuthConfig

interface DomainAuthConfig

property authType

authType?: pulumi.Input<string>;

Auth type of the auth config. Valid values are noAuth, typeA, typeB and typeC. Default value is noAuth.

property masterKey

masterKey?: pulumi.Input<string>;

Master authentication key of the auth config. This parameter can have a string of 6 to 32 characters and must contain only alphanumeric characters.

property slaveKey

slaveKey?: pulumi.Input<string>;

Slave authentication key of the auth config. This parameter can have a string of 6 to 32 characters and must contain only alphanumeric characters.

property timeout

timeout?: pulumi.Input<number>;

Authentication cache time of the auth config. Default value is 1800. It’s value is valid only when the authType is typeB or typeC.

interface DomainCacheConfig

interface DomainCacheConfig

property cacheContent

cacheContent: pulumi.Input<string>;

Cache content of the cache config. It’s value is a path string when the cacheType is path. When the cacheType is suffix, it’s value is a string which contains multiple file suffixes separated by commas.

property cacheId

cacheId?: pulumi.Input<string>;

property cacheType

cacheType: pulumi.Input<string>;

Cache type of the cache config. Valid values are suffix and path.

property ttl

ttl: pulumi.Input<number>;

Cache time of the cache config.

property weight

weight?: pulumi.Input<number>;

Weight of the cache config. This parameter’s value is between 1 and 99. Default value is 1. The higher the value, the higher the priority.

interface DomainCertificateConfig

interface DomainCertificateConfig

property privateKey

privateKey?: pulumi.Input<string>;

The SSL private key. This is required if serverCertificateStatus is on

property serverCertificate

serverCertificate?: pulumi.Input<string>;

The SSL server certificate string. This is required if serverCertificateStatus is on

property serverCertificateStatus

serverCertificateStatus?: pulumi.Input<string>;

This parameter indicates whether or not enable https. Valid values are on and off. Default value is on.

interface DomainConfigFunctionArg

interface DomainConfigFunctionArg

property argName

argName: pulumi.Input<string>;

The name of arg.

property argValue

argValue: pulumi.Input<string>;

The value of arg.

interface DomainHttpHeaderConfig

interface DomainHttpHeaderConfig

property headerId

headerId?: pulumi.Input<string>;

property headerKey

headerKey: pulumi.Input<string>;

Header key of the http header. Valid values are Content-Type, Cache-Control, Content-Disposition, Content-Language，Expires, Access-Control-Allow-Origin, Access-Control-Allow-Methods and Access-Control-Max-Age.

property headerValue

headerValue: pulumi.Input<string>;

Header value of the http header.

interface DomainNewCertificateConfig

interface DomainNewCertificateConfig

property certName

certName?: pulumi.Input<string>;

The SSL certificate name.

property certType

certType?: pulumi.Input<string>;

The SSL certificate type, can be “upload”, “cas” and “free”.

property forceSet

forceSet?: pulumi.Input<string>;

Set 1 to ignore the repeated verification for certificate name, and cover the information of the origin certificate (with the same name). Set 0 to work the verification.

property privateKey

privateKey?: pulumi.Input<string>;

The SSL private key. This is required if serverCertificateStatus is on

property serverCertificate

serverCertificate?: pulumi.Input<string>;

The SSL server certificate string. This is required if serverCertificateStatus is on

property serverCertificateStatus

serverCertificateStatus?: pulumi.Input<string>;

This parameter indicates whether or not enable https. Valid values are on and off. Default value is on.

interface DomainNewSources

interface DomainNewSources

property content

content: pulumi.Input<string>;

The adress of source. Valid values can be ip or doaminName. Each item’s content can not be repeated.

property port

port?: pulumi.Input<number>;

The port of source. Valid values are 443 and 80. Default value is 80.

property priority

priority?: pulumi.Input<number>;

Priority of the source. Valid values are 0 and 100. Default value is 20.

property type

type: pulumi.Input<string>;

The type of the source. Valid values are ipaddr, domain and oss.

property weight

weight?: pulumi.Input<number>;

Weight of the source. Valid values are from 0 to 100. Default value is 10, but if type is ipaddr, the value can only be 10.

interface DomainPage404Config

interface DomainPage404Config

property customPageUrl

customPageUrl?: pulumi.Input<string>;

Custom page url of the error page. It must be the full path under the accelerated domain name. It’s value must be http://promotion.alicdn.com/help/oss/error.html when pageType value is charity and It can not be set when pageType value is default.

property errorCode

errorCode?: pulumi.Input<string>;

property pageType

pageType?: pulumi.Input<string>;

Page type of the error page. Valid values are default, charity, other. Default value is default.

interface DomainParameterFilterConfig

interface DomainParameterFilterConfig

property enable

enable?: pulumi.Input<string>;

This parameter indicates whether or not the parameterFilterConfig is enable. Valid values are on and off. Default value is off.

property hashKeyArgs

hashKeyArgs?: pulumi.Input<pulumi.Input<string>[]>;

Reserved parameters of parameterFilterConfig. It’s a list of string and consists of at most 10 items.

interface DomainReferConfig

interface DomainReferConfig

property allowEmpty

allowEmpty?: pulumi.Input<string>;

This parameter indicates whether or not to allow empty refer access. Valid values are on and off. Default value is on.

property referLists

referLists: pulumi.Input<pulumi.Input<string>[]>;

A list of domain names of the refer config.

property referType

referType?: pulumi.Input<string>;

Refer type of the refer config. Valid values are block and allow. Default value is block.

namespace cms

interface SiteMonitorIspCity

interface SiteMonitorIspCity

property city

city: pulumi.Input<string>;

property isp

isp: pulumi.Input<string>;

namespace cr

interface RepoDomainList

interface RepoDomainList

property internal

internal?: pulumi.Input<string>;

Domain of internal endpoint, only in some regions.

property public

public?: pulumi.Input<string>;

Domain of public endpoint.

property vpc

vpc?: pulumi.Input<string>;

Domain of vpc endpoint.

namespace cs

interface ApplicationService

interface ApplicationService

property id

id?: pulumi.Input<string>;

ID of the service.

property name

name?: pulumi.Input<string>;

The application name. It should be 1-64 characters long, and can contain numbers, English letters and hyphens, but cannot start with hyphens.

property status

status?: pulumi.Input<string>;

The current status of service.

property version

version?: pulumi.Input<string>;

The application deploying version. Each updating, it must be different with current. Default to “1.0”

interface ClusterNode

interface ClusterNode

property eip

eip?: pulumi.Input<string>;

property id

id?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

property privateIp

privateIp?: pulumi.Input<string>;

property status

status?: pulumi.Input<string>;

interface KubernetesAddon

interface KubernetesAddon

property config

config?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The kubernetes cluster’s name. It is unique in one Alicloud account.

interface KubernetesAutoscalerNodepool

interface KubernetesAutoscalerNodepool

property id

id?: pulumi.Input<string>;

property labels

labels?: pulumi.Input<string>;

property taints

taints?: pulumi.Input<string>;

interface KubernetesConnections

interface KubernetesConnections

property apiServerInternet

apiServerInternet?: pulumi.Input<string>;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet?: pulumi.Input<string>;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp?: pulumi.Input<string>;

Master node SSH IP address.

property serviceDomain

serviceDomain?: pulumi.Input<string>;

Service Access Domain.

interface KubernetesMasterNode

interface KubernetesMasterNode

property id

id?: pulumi.Input<string>;

ID of the node.

property name

name?: pulumi.Input<string>;

The kubernetes cluster’s name. It is unique in one Alicloud account.

property privateIp

privateIp?: pulumi.Input<string>;

The private IP address of node.

interface KubernetesWorkerNode

interface KubernetesWorkerNode

property id

id?: pulumi.Input<string>;

ID of the node.

property name

name?: pulumi.Input<string>;

The kubernetes cluster’s name. It is unique in one Alicloud account.

property privateIp

privateIp?: pulumi.Input<string>;

The private IP address of node.

interface ManagedKubernetesAddon

interface ManagedKubernetesAddon

property config

config?: pulumi.Input<string>;

property disabled

disabled?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The kubernetes cluster’s name. It is unique in one Alicloud account.

interface ManagedKubernetesConnections

interface ManagedKubernetesConnections

property apiServerInternet

apiServerInternet?: pulumi.Input<string>;

API Server Internet endpoint.

property apiServerIntranet

apiServerIntranet?: pulumi.Input<string>;

API Server Intranet endpoint.

property masterPublicIp

masterPublicIp?: pulumi.Input<string>;

property serviceDomain

serviceDomain?: pulumi.Input<string>;

Service Access Domain.

interface ManagedKubernetesWorkerNode

interface ManagedKubernetesWorkerNode

property id

id?: pulumi.Input<string>;

ID of the node.

property name

name?: pulumi.Input<string>;

The kubernetes cluster’s name. It is unique in one Alicloud account.

property privateIp

privateIp?: pulumi.Input<string>;

The private IP address of node.

interface SwarmNode

interface SwarmNode

property eip

eip?: pulumi.Input<string>;

The Elastic IP address of node.

property id

id?: pulumi.Input<string>;

ID of the node.

property name

name?: pulumi.Input<string>;

The container cluster’s name. It is the only in one Alicloud account.

property privateIp

privateIp?: pulumi.Input<string>;

The private IP address of node.

property status

status?: pulumi.Input<string>;

The node current status. It is different with instance status.

namespace ddos

interface SchedulerRuleRule

interface SchedulerRuleRule

property priority

priority?: pulumi.Input<number>;

property regionId

regionId?: pulumi.Input<string>;

property status

status?: pulumi.Input<number>;

property type

type?: pulumi.Input<string>;

property value

value?: pulumi.Input<string>;

property valueType

valueType?: pulumi.Input<number>;

namespace ecs

interface AutoProvisioningGroupLaunchTemplateConfig

interface AutoProvisioningGroupLaunchTemplateConfig

property instanceType

instanceType?: pulumi.Input<string>;

property maxPrice

maxPrice: pulumi.Input<string>;

property priority

priority?: pulumi.Input<string>;

property vswitchId

vswitchId: pulumi.Input<string>;

property weightedCapacity

weightedCapacity?: pulumi.Input<string>;

interface ImageDiskDeviceMapping

interface ImageDiskDeviceMapping

property device

device?: pulumi.Input<string>;

Specifies the name of a disk in the combined custom image. Value range: /dev/xvda to /dev/xvdz.

property diskType

diskType?: pulumi.Input<string>;

Specifies the type of a disk in the combined custom image. If you specify this parameter, you can use a data disk snapshot as the data source of a system disk for creating an image. If it is not specified, the disk type is determined by the corresponding snapshot. Valid values: system, data,

property size

size?: pulumi.Input<number>;

Specifies the size of a disk in the combined custom image, in GiB. Value range: 5 to 2000.

property snapshotId

snapshotId?: pulumi.Input<string>;

Specifies a snapshot that is used to create a combined custom image.

interface ImageImportDiskDeviceMapping

interface ImageImportDiskDeviceMapping

property device

device?: pulumi.Input<string>;

The name of disk N in the custom image.

property diskImageSize

diskImageSize?: pulumi.Input<number>;

Resolution size. You must ensure that the system disk space ≥ file system space. Ranges: When n = 1, the system disk: 5 ~ 500GiB, When n = 2 ~ 17, that is, data disk: 5 ~ 1000GiB, When temporary is introduced, the system automatically detects the size, which is subject to the detection result.

property format

format?: pulumi.Input<string>;

Image format. Value range: When the RAW, VHD, qcow2 is imported into the image, the system automatically detects the image format, whichever comes first.

property ossBucket

ossBucket?: pulumi.Input<string>;

Save the exported OSS bucket.

property ossObject

ossObject?: pulumi.Input<string>;

The file name of your OSS Object.

interface InstanceDataDisk

interface InstanceDataDisk

property autoSnapshotPolicyId

autoSnapshotPolicyId?: pulumi.Input<string>;

The ID of the automatic snapshot policy applied to the system disk.

property category

category?: pulumi.Input<string>;

The category of the disk: - cloud: The general cloud disk. - cloudEfficiency: The efficiency cloud disk. - cloudSsd: The SSD cloud disk. - cloudEssd: The ESSD cloud disk. - ephemeralSsd: The local SSD disk. Default to cloudEfficiency.

property deleteWithInstance

deleteWithInstance?: pulumi.Input<boolean>;

Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloud_essd, cloudSsd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

property description

description?: pulumi.Input<string>;

The description of the data disk.

property encrypted

encrypted?: pulumi.Input<boolean>;

-(Optional, Bool, ForceNew) Encrypted the data in this disk.

property name

name?: pulumi.Input<string>;

The name of the data disk.

property size

size: pulumi.Input<number>;

The size of the data disk. - cloud：[5, 2000] - cloud_efficiency：[20, 32768] - cloud_ssd：[20, 32768] - cloud_essd：[20, 32768] - ephemeral_ssd: [5, 800]

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

interface LaunchTemplateDataDisk

interface LaunchTemplateDataDisk

property category

category?: pulumi.Input<string>;

The category of the disk: - cloud: Basic cloud disk. - cloud_efficiency: Ultra cloud disk. - cloud_ssd: SSD cloud Disks. - ephemeral_ssd: local SSD Disks - cloud_essd: ESSD cloud Disks.

property deleteWithInstance

deleteWithInstance?: pulumi.Input<boolean>;

Delete this data disk when the instance is destroyed. It only works on cloud, cloud_efficiency, cloudSsd and cloudEssd disk. If the category of this data disk was ephemeral_ssd, please don’t set this param.

property description

description?: pulumi.Input<string>;

The description of the data disk.

property encrypted

encrypted?: pulumi.Input<boolean>;

-(Optional, Bool) Encrypted the data in this disk.

property name

name?: pulumi.Input<string>;

The name of the data disk.

property size

size?: pulumi.Input<number>;

The size of the data disk. - cloud：[5, 2000] - cloud_efficiency：[20, 32768] - cloud_ssd：[20, 32768] - cloud_essd：[20, 32768] - ephemeral_ssd: [5, 800]

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID used to initialize the data disk. If the size specified by snapshot is greater that the size of the disk, use the size specified by snapshot as the size of the data disk.

interface LaunchTemplateNetworkInterfaces

interface LaunchTemplateNetworkInterfaces

property description

description?: pulumi.Input<string>;

The description of the data disk.

property name

name?: pulumi.Input<string>;

The name of the data disk.

property primaryIp

primaryIp?: pulumi.Input<string>;

The primary private IP address of the ENI.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The security group ID must be one in the same VPC.

property vswitchId

vswitchId?: pulumi.Input<string>;

The VSwitch ID for ENI. The instance must be in the same zone of the same VPC network as the ENI, but they may belong to different VSwitches.

namespace emr

interface ClusterBootstrapAction

interface ClusterBootstrapAction

property arg

arg?: pulumi.Input<string>;

bootstrap action args, e.g. “–a=b”.

property name

name?: pulumi.Input<string>;

bootstrap action name.

property path

path?: pulumi.Input<string>;

bootstrap action path, e.g. “oss://bucket/path”.

interface ClusterHostGroup

interface ClusterHostGroup

property autoRenew

autoRenew?: pulumi.Input<boolean>;

Auto renew for prepaid, true of false. Default is false.

property chargeType

chargeType?: pulumi.Input<string>;

Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global chargeType value.

property diskCapacity

diskCapacity?: pulumi.Input<string>;

Data disk capacity.

property diskCount

diskCount?: pulumi.Input<string>;

Data disk count.

property diskType

diskType?: pulumi.Input<string>;

Data disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,local_disk,cloud_essd.

property gpuDriver

gpuDriver?: pulumi.Input<string>;

property hostGroupName

hostGroupName?: pulumi.Input<string>;

host group name.

property hostGroupType

hostGroupType?: pulumi.Input<string>;

host group type, supported value: MASTER, CORE or TASK, supported ‘GATEWAY’ available in 1.61.0+.

property instanceList

instanceList?: pulumi.Input<string>;

Instance list for cluster scale down. This value follows the json format, e.g. [“instanceId1”,“instanceId2”]. escape character for “ is \“.

property instanceType

instanceType?: pulumi.Input<string>;

Host Ecs instance type.

property nodeCount

nodeCount?: pulumi.Input<string>;

Host number in this group.

property period

period?: pulumi.Input<number>;

If charge type is PrePaid, this should be specified, unit is month. Supported value: 1、2、3、4、5、6、7、8、9、12、24、36.

property sysDiskCapacity

sysDiskCapacity?: pulumi.Input<string>;

System disk capacity.

property sysDiskType

sysDiskType?: pulumi.Input<string>;

System disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,cloud_essd.

namespace ess

interface ScalingConfigurationDataDisk

interface ScalingConfigurationDataDisk

property category

category?: pulumi.Input<string>;

property deleteWithInstance

deleteWithInstance?: pulumi.Input<boolean>;

property device

device?: pulumi.Input<string>;

property size

size?: pulumi.Input<number>;

property snapshotId

snapshotId?: pulumi.Input<string>;

interface ScalingGroupVServerGroupsVserverGroup

interface ScalingGroupVServerGroupsVserverGroup

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

property vserverAttributes

vserverAttributes: pulumi.Input<pulumi.Input<ScalingGroupVServerGroupsVserverGroupVserverAttribute>[]>;

interface ScalingGroupVServerGroupsVserverGroupVserverAttribute

interface ScalingGroupVServerGroupsVserverGroupVserverAttribute

property port

port: pulumi.Input<number>;

property vserverGroupId

vserverGroupId: pulumi.Input<string>;

property weight

weight: pulumi.Input<number>;

interface ScalingRuleStepAdjustment

interface ScalingRuleStepAdjustment

property metricIntervalLowerBound

metricIntervalLowerBound?: pulumi.Input<string>;

property metricIntervalUpperBound

metricIntervalUpperBound?: pulumi.Input<string>;

property scalingAdjustment

scalingAdjustment?: pulumi.Input<number>;

namespace fc

interface ServiceLogConfig

interface ServiceLogConfig

property logstore

logstore: pulumi.Input<string>;

The log store name of Logs service.

property project

project: pulumi.Input<string>;

The project name of Logs service.

interface ServiceVpcConfig

interface ServiceVpcConfig

property securityGroupId

securityGroupId: pulumi.Input<string>;

A security group ID associated with the FC service.

property vpcId

vpcId?: pulumi.Input<string>;

property vswitchIds

vswitchIds: pulumi.Input<pulumi.Input<string>[]>;

A list of vswitch IDs associated with the FC service.

namespace kvstore

interface InstanceParameter

interface InstanceParameter

property name

name: pulumi.Input<string>;

property value

value: pulumi.Input<string>;

namespace log

interface AlertNotificationList

interface AlertNotificationList

property content

content: pulumi.Input<string>;

Notice content of alarm.

property emailLists

emailLists?: pulumi.Input<pulumi.Input<string>[]>;

Email address list.

property mobileLists

mobileLists?: pulumi.Input<pulumi.Input<string>[]>;

SMS sending mobile number.

property serviceUri

serviceUri?: pulumi.Input<string>;

Request address.

property type

type: pulumi.Input<string>;

Notification type. support Email, SMS, DingTalk.

interface AlertQueryList

interface AlertQueryList

property chartTitle

chartTitle: pulumi.Input<string>;

chart title

property end

end: pulumi.Input<string>;

end time. example: 20s.

property logstore

logstore: pulumi.Input<string>;

Query logstore

property query

query: pulumi.Input<string>;

query corresponding to chart. example: * AND aliyun.

property start

start: pulumi.Input<string>;

begin time. example: -60s.

property timeSpanType

timeSpanType?: pulumi.Input<string>;

default Custom. No need to configure this parameter.

interface StoreIndexFieldSearch

interface StoreIndexFieldSearch

property alias

alias?: pulumi.Input<string>;

The alias of one field.

property caseSensitive

caseSensitive?: pulumi.Input<boolean>;

Whether the case sensitive for the field. Default to false. It is valid when “type” is “text” or “json”.

property enableAnalytics

enableAnalytics?: pulumi.Input<boolean>;

Whether to enable field analytics. Default to true.

property includeChinese

includeChinese?: pulumi.Input<boolean>;

Whether includes the chinese for the field. Default to false. It is valid when “type” is “text” or “json”.

property jsonKeys

jsonKeys?: pulumi.Input<pulumi.Input<StoreIndexFieldSearchJsonKey>[]>;

Use nested index when type is json

property name

name: pulumi.Input<string>;

When using the jsonKeys field, this field is required.

property token

token?: pulumi.Input<string>;

The string of several split words, like “\r”, “#”. It is valid when “type” is “text” or “json”.

property type

type?: pulumi.Input<string>;

The type of one field. Valid values: [“long”, “text”, “double”]. Default to “long”

interface StoreIndexFieldSearchJsonKey

interface StoreIndexFieldSearchJsonKey

property alias

alias?: pulumi.Input<string>;

The alias of one field.

property docValue

docValue?: pulumi.Input<boolean>;

Whether to enable statistics. default to true.

property name

name: pulumi.Input<string>;

When using the jsonKeys field, this field is required.

property type

type?: pulumi.Input<string>;

The type of one field. Valid values: [“long”, “text”, “double”]. Default to “long”

interface StoreIndexFullText

interface StoreIndexFullText

property caseSensitive

caseSensitive?: pulumi.Input<boolean>;

Whether the case sensitive for the field. Default to false. It is valid when “type” is “text” or “json”.

property includeChinese

includeChinese?: pulumi.Input<boolean>;

Whether includes the chinese for the field. Default to false. It is valid when “type” is “text” or “json”.

property token

token?: pulumi.Input<string>;

The string of several split words, like “\r”, “#”. It is valid when “type” is “text” or “json”.

interface StoreShard

interface StoreShard

property beginKey

beginKey?: pulumi.Input<string>;

property endKey

endKey?: pulumi.Input<string>;

property id

id?: pulumi.Input<number>;

The ID of the log project. It formats of <project>:<name>.

property status

status?: pulumi.Input<string>;

namespace mongodb

interface ShardingInstanceMongoList

interface ShardingInstanceMongoList

property connectString

connectString?: pulumi.Input<string>;

Mongo node connection string

property nodeClass

nodeClass: pulumi.Input<string>;

-(Required) Node specification. see Instance specifications.

property nodeId

nodeId?: pulumi.Input<string>;

The ID of the shard-node.

property port

port?: pulumi.Input<number>;

Mongo node port * shardList

interface ShardingInstanceShardList

interface ShardingInstanceShardList

property nodeClass

nodeClass: pulumi.Input<string>;

-(Required) Node specification. see Instance specifications.

property nodeId

nodeId?: pulumi.Input<string>;

The ID of the shard-node.

property nodeStorage

nodeStorage: pulumi.Input<number>;

Custom storage space; value range: [10, 1,000]
10-GB increments. Unit: GB.

namespace oss

interface BucketCorsRule

interface BucketCorsRule

property allowedHeaders

allowedHeaders?: pulumi.Input<pulumi.Input<string>[]>;

Specifies which headers are allowed.

property allowedMethods

allowedMethods: pulumi.Input<pulumi.Input<string>[]>;

Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD.

property allowedOrigins

allowedOrigins: pulumi.Input<pulumi.Input<string>[]>;

Specifies which origins are allowed.

property exposeHeaders

exposeHeaders?: pulumi.Input<pulumi.Input<string>[]>;

Specifies expose header in the response.

property maxAgeSeconds

maxAgeSeconds?: pulumi.Input<number>;

Specifies time in seconds that browser can cache the response for a preflight request.

interface BucketLifecycleRule

interface BucketLifecycleRule

property enabled

enabled: pulumi.Input<boolean>;

Specifies lifecycle rule status.

property expirations

expirations?: pulumi.Input<pulumi.Input<BucketLifecycleRuleExpiration>[]>;

Specifies a period in the object’s expire (documented below).

property id

id?: pulumi.Input<string>;

Unique identifier for the rule. If omitted, OSS bucket will assign a unique name.

property prefix

prefix: pulumi.Input<string>;

Object key prefix identifying one or more objects to which the rule applies.

property transitions

transitions?: pulumi.Input<pulumi.Input<BucketLifecycleRuleTransition>[]>;

Specifies the time when an object is converted to the IA or archive storage class during a valid life cycle. (documented below).

interface BucketLifecycleRuleExpiration

interface BucketLifecycleRuleExpiration

property date

date?: pulumi.Input<string>;

Specifies the date after which you want the corresponding action to take effect. The value obeys ISO8601 format like 2017-03-09.

property days

days?: pulumi.Input<number>;

Specifies the number of days after object creation when the specific rule action takes effect.

interface BucketLifecycleRuleTransition

interface BucketLifecycleRuleTransition

property createdBeforeDate

createdBeforeDate?: pulumi.Input<string>;

Specifies the time before which the rules take effect. The date must conform to the ISO8601 format and always be UTC 00:00. For example: 2002-10-11T00:00:00.000Z indicates that objects updated before 2002-10-11T00:00:00.000Z are deleted or converted to another storage class, and objects updated after this time (including this time) are not deleted or converted.

property days

days?: pulumi.Input<number>;

Specifies the number of days after object creation when the specific rule action takes effect.

property storageClass

storageClass?: pulumi.Input<string>;

Specifies the storage class that objects that conform to the rule are converted into. The storage class of the objects in a bucket of the IA storage class can be converted into Archive but cannot be converted into Standard. Values: IA, Archive.

interface BucketLogging

interface BucketLogging

property targetBucket

targetBucket: pulumi.Input<string>;

The name of the bucket that will receive the log objects.

property targetPrefix

targetPrefix?: pulumi.Input<string>;

To specify a key prefix for log objects.

interface BucketRefererConfig

interface BucketRefererConfig

property allowEmpty

allowEmpty?: pulumi.Input<boolean>;

Allows referer to be empty. Defaults false.

property referers

referers: pulumi.Input<pulumi.Input<string>[]>;

The list of referer.

interface BucketServerSideEncryptionRule

interface BucketServerSideEncryptionRule

property sseAlgorithm

sseAlgorithm: pulumi.Input<string>;

The server-side encryption algorithm to use. Possible values: AES256 and KMS.

interface BucketVersioning

interface BucketVersioning

property status

status: pulumi.Input<string>;

Specifies the versioning state of a bucket. Valid values: Enabled and Suspended.

interface BucketWebsite

interface BucketWebsite

property errorDocument

errorDocument?: pulumi.Input<string>;

An absolute path to the document to return in case of a 4XX error.

property indexDocument

indexDocument: pulumi.Input<string>;

Alicloud OSS returns this index document when requests are made to the root domain or any of the subfolders.

namespace ots

interface TablePrimaryKey

interface TablePrimaryKey

property name

name: pulumi.Input<string>;

Name for primary key.

property type

type: pulumi.Input<string>;

Type for primary key. Only Integer, String or Binary is allowed.

namespace polardb

interface ClusterParameter

interface ClusterParameter

property name

name: pulumi.Input<string>;

property value

value: pulumi.Input<string>;

namespace pvtz

interface ZoneAttachmentVpc

interface ZoneAttachmentVpc

property regionId

regionId?: pulumi.Input<string>;

The region of the vpc. If not set, the current region will instead of.

property vpcId

vpcId: pulumi.Input<string>;

The Id of the vpc.

namespace ram

interface PolicyStatement

interface PolicyStatement

property actions

actions: pulumi.Input<pulumi.Input<string>[]>;

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of operations for the resource. The format of each item in this list is ${service}:${action_name}, such as oss:ListBuckets and ecs:Describe*. The ${service} can be ecs, oss, ots and so on, the ${action_name} refers to the name of an api interface which related to the ${service}.

property effect

effect: pulumi.Input<string>;

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) This parameter indicates whether or not the action is allowed. Valid values are Allow and Deny.

property resources

resources: pulumi.Input<pulumi.Input<string>[]>;

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of specific objects which will be authorized. The format of each item in this list is acs:${service}:${region}:${account_id}:${relative_id}, such as acs:ecs:*:*:instance/inst-002 and acs:oss:*:1234567890000:mybucket. The ${service} can be ecs, oss, ots and so on, the ${region} is the region info which can use * replace when it is not supplied, the ${account_id} refers to someone’s Alicloud account id or you can use * to replace, the ${relative_id} is the resource description section which related to the ${service}.

namespace rds

interface InstanceParameter

interface InstanceParameter

property name

name: pulumi.Input<string>;

property value

value: pulumi.Input<string>;

interface ReadOnlyInstanceParameter

interface ReadOnlyInstanceParameter

property name

name: pulumi.Input<string>;

property value

value: pulumi.Input<string>;

namespace resourcemanager

interface ResourceGroupRegionStatus

interface ResourceGroupRegionStatus

property regionId

regionId?: pulumi.Input<string>;

property status

status?: pulumi.Input<string>;

The status of the resource group.

namespace slb

interface AclEntryList

interface AclEntryList

property comment

comment?: pulumi.Input<string>;

property entry

entry: pulumi.Input<string>;

interface BackendServerBackendServer

interface BackendServerBackendServer

property serverId

serverId: pulumi.Input<string>;

property type

type?: pulumi.Input<string>;

property weight

weight: pulumi.Input<number>;

interface ListenerXForwardedFor

interface ListenerXForwardedFor

property retriveClientIp

retriveClientIp?: pulumi.Input<boolean>;

property retriveSlbId

retriveSlbId?: pulumi.Input<boolean>;

Whether to use the XForwardedFor header to obtain the ID of the SLB instance. Default to false.

property retriveSlbIp

retriveSlbIp?: pulumi.Input<boolean>;

Whether to use the XForwardedFor_SLBIP header to obtain the public IP address of the SLB instance. Default to false.

property retriveSlbProto

retriveSlbProto?: pulumi.Input<boolean>;

Whether to use the XForwardedFor_proto header to obtain the protocol used by the listener. Default to false.

interface MasterSlaveServerGroupServer

interface MasterSlaveServerGroupServer

property port

port: pulumi.Input<number>;

property serverId

serverId: pulumi.Input<string>;

property serverType

serverType?: pulumi.Input<string>;

property type

type?: pulumi.Input<string>;

property weight

weight?: pulumi.Input<number>;

interface ServerGroupServer

interface ServerGroupServer

property port

port: pulumi.Input<number>;

property serverIds

serverIds: pulumi.Input<pulumi.Input<string>[]>;

property type

type?: pulumi.Input<string>;

property weight

weight?: pulumi.Input<number>;

namespace vpc

interface NatGatewayBandwidthPackage

interface NatGatewayBandwidthPackage

property bandwidth

bandwidth: pulumi.Input<number>;

property ipCount

ipCount: pulumi.Input<number>;

property publicIpAddresses

publicIpAddresses?: pulumi.Input<string>;

property zone

zone?: pulumi.Input<string>;

interface NetworkAclAttachmentResource

interface NetworkAclAttachmentResource

property resourceId

resourceId: pulumi.Input<string>;

The resource id that the network acl will associate with.

property resourceType

resourceType: pulumi.Input<string>;

The resource id that the network acl will associate with. Only support VSwitch now.

interface NetworkAclEntriesEgress

interface NetworkAclEntriesEgress

property description

description?: pulumi.Input<string>;

The description of the egress entry.

property destinationCidrIp

destinationCidrIp?: pulumi.Input<string>;

The destination ip of the egress entry.

property entryType

entryType?: pulumi.Input<string>;

The entry type of the egress entry. It must be custom or system. Default value is custom.

property name

name?: pulumi.Input<string>;

The name of the egress entry.

property policy

policy?: pulumi.Input<string>;

The policy of the egress entry. It must be accept or drop.

property port

port?: pulumi.Input<string>;

The port of the egress entry.

property protocol

protocol?: pulumi.Input<string>;

The protocol of the egress entry.

interface NetworkAclEntriesIngress

interface NetworkAclEntriesIngress

property description

description?: pulumi.Input<string>;

The description of the egress entry.

property entryType

entryType?: pulumi.Input<string>;

The entry type of the egress entry. It must be custom or system. Default value is custom.

property name

name?: pulumi.Input<string>;

The name of the egress entry.

property policy

policy?: pulumi.Input<string>;

The policy of the egress entry. It must be accept or drop.

property port

port?: pulumi.Input<string>;

The port of the egress entry.

property protocol

protocol?: pulumi.Input<string>;

The protocol of the egress entry.

property sourceCidrIp

sourceCidrIp?: pulumi.Input<string>;

The source ip of the ingress entry.

namespace vpn

interface ConnectionIkeConfig

interface ConnectionIkeConfig

property ikeAuthAlg

ikeAuthAlg?: pulumi.Input<string>;

The authentication algorithm of phase-one negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1

property ikeEncAlg

ikeEncAlg?: pulumi.Input<string>;

The encryption algorithm of phase-one negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default Valid value: aes

property ikeLifetime

ikeLifetime?: pulumi.Input<number>;

The SA lifecycle as the result of phase-one negotiation. The valid value of n is [0, 86400], the unit is second and the default value is 86400.

property ikeLocalId

ikeLocalId?: pulumi.Input<string>;

The identification of the VPN gateway.

property ikeMode

ikeMode?: pulumi.Input<string>;

The negotiation mode of IKE V1. Valid value: main (main mode) | aggressive (aggressive mode). Default value: main

property ikePfs

ikePfs?: pulumi.Input<string>;

The Diffie-Hellman key exchange algorithm used by phase-one negotiation. Valid value: group1 | group2 | group5 | group14 | group24. Default value: group2

property ikeRemoteId

ikeRemoteId?: pulumi.Input<string>;

The identification of the customer gateway.

property ikeVersion

ikeVersion?: pulumi.Input<string>;

The version of the IKE protocol. Valid value: ikev1 | ikev2. Default value: ikev1

property psk

psk?: pulumi.Input<string>;

Used for authentication between the IPsec VPN gateway and the customer gateway.

interface ConnectionIpsecConfig

interface ConnectionIpsecConfig

property ipsecAuthAlg

ipsecAuthAlg?: pulumi.Input<string>;

The authentication algorithm of phase-two negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1

property ipsecEncAlg

ipsecEncAlg?: pulumi.Input<string>;

The encryption algorithm of phase-two negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default value: aes

property ipsecLifetime

ipsecLifetime?: pulumi.Input<number>;

The SA lifecycle as the result of phase-two negotiation. The valid value is [0, 86400], the unit is second and the default value is 86400.

property ipsecPfs

ipsecPfs?: pulumi.Input<string>;

namespace waf

interface DomainLogHeader

interface DomainLogHeader

property key

key?: pulumi.Input<string>;

property value

value?: pulumi.Input<string>;

APIs

interface ProviderAssumeRole

interface ProviderAssumeRole

property policy

policy?: pulumi.Input<string>;

property roleArn

roleArn: pulumi.Input<string>;

property sessionExpiration

sessionExpiration?: pulumi.Input<number>;

property sessionName

sessionName?: pulumi.Input<string>;

interface ProviderEndpoint

interface ProviderEndpoint

property actiontrail

actiontrail?: pulumi.Input<string>;

property adb

adb?: pulumi.Input<string>;

property alidns

alidns?: pulumi.Input<string>;

property alikafka

alikafka?: pulumi.Input<string>;

property apigateway

apigateway?: pulumi.Input<string>;

property bssopenapi

bssopenapi?: pulumi.Input<string>;

property cas

cas?: pulumi.Input<string>;

property cbn

cbn?: pulumi.Input<string>;

property cdn

cdn?: pulumi.Input<string>;

property cen

cen?: pulumi.Input<string>;

property cms

cms?: pulumi.Input<string>;

property cr

cr?: pulumi.Input<string>;

property cs

cs?: pulumi.Input<string>;

property datahub

datahub?: pulumi.Input<string>;

property ddosbgp

ddosbgp?: pulumi.Input<string>;

property ddoscoo

ddoscoo?: pulumi.Input<string>;

property dds

dds?: pulumi.Input<string>;

property dmsEnterprise

dmsEnterprise?: pulumi.Input<string>;

property dns

dns?: pulumi.Input<string>;

property drds

drds?: pulumi.Input<string>;

property ecs

ecs?: pulumi.Input<string>;

property elasticsearch

elasticsearch?: pulumi.Input<string>;

property emr

emr?: pulumi.Input<string>;

property ess

ess?: pulumi.Input<string>;

property fc

fc?: pulumi.Input<string>;

property gpdb

gpdb?: pulumi.Input<string>;

property kms

kms?: pulumi.Input<string>;

property kvstore

kvstore?: pulumi.Input<string>;

property location

location?: pulumi.Input<string>;

property log

log?: pulumi.Input<string>;

property market

market?: pulumi.Input<string>;

property maxcompute

maxcompute?: pulumi.Input<string>;

property mns

mns?: pulumi.Input<string>;

property nas

nas?: pulumi.Input<string>;

property ons

ons?: pulumi.Input<string>;

property oss

oss?: pulumi.Input<string>;

property ots

ots?: pulumi.Input<string>;

property polardb

polardb?: pulumi.Input<string>;

property pvtz

pvtz?: pulumi.Input<string>;

property ram

ram?: pulumi.Input<string>;

property rds

rds?: pulumi.Input<string>;

property resourcemanager

resourcemanager?: pulumi.Input<string>;

property slb

slb?: pulumi.Input<string>;

property sts

sts?: pulumi.Input<string>;

property vpc

vpc?: pulumi.Input<string>;

property wafOpenapi

wafOpenapi?: pulumi.Input<string>;

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module types/input

namespace apigateway

namespace cdn

namespace cms

namespace cr

namespace cs

namespace ddos

namespace ecs

namespace emr

namespace ess

namespace fc

namespace kvstore

namespace log

namespace mongodb

namespace oss

namespace ots

namespace polardb

namespace pvtz

namespace ram

namespace rds

namespace resourcemanager

namespace slb

namespace vpc

namespace vpn

namespace waf

APIs

namespace apigateway

namespace cdn

namespace cms

namespace cr

namespace cs