Documentation
¶
Overview ¶
A Pulumi package for creating and managing Tencent Cloud resources.
Index ¶
- type Provider
- type ProviderArgs
- type ProviderAssumeRole
- type ProviderAssumeRoleArgs
- func (ProviderAssumeRoleArgs) ElementType() reflect.Type
- func (i ProviderAssumeRoleArgs) ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput
- func (i ProviderAssumeRoleArgs) ToProviderAssumeRoleOutputWithContext(ctx context.Context) ProviderAssumeRoleOutput
- func (i ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
- func (i ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput
- type ProviderAssumeRoleInput
- type ProviderAssumeRoleOutput
- func (ProviderAssumeRoleOutput) ElementType() reflect.Type
- func (o ProviderAssumeRoleOutput) Policy() pulumi.StringPtrOutput
- func (o ProviderAssumeRoleOutput) RoleArn() pulumi.StringOutput
- func (o ProviderAssumeRoleOutput) SessionDuration() pulumi.IntOutput
- func (o ProviderAssumeRoleOutput) SessionName() pulumi.StringOutput
- func (o ProviderAssumeRoleOutput) ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput
- func (o ProviderAssumeRoleOutput) ToProviderAssumeRoleOutputWithContext(ctx context.Context) ProviderAssumeRoleOutput
- func (o ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
- func (o ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput
- type ProviderAssumeRolePtrInput
- type ProviderAssumeRolePtrOutput
- func (o ProviderAssumeRolePtrOutput) Elem() ProviderAssumeRoleOutput
- func (ProviderAssumeRolePtrOutput) ElementType() reflect.Type
- func (o ProviderAssumeRolePtrOutput) Policy() pulumi.StringPtrOutput
- func (o ProviderAssumeRolePtrOutput) RoleArn() pulumi.StringPtrOutput
- func (o ProviderAssumeRolePtrOutput) SessionDuration() pulumi.IntPtrOutput
- func (o ProviderAssumeRolePtrOutput) SessionName() pulumi.StringPtrOutput
- func (o ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
- func (o ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput
- type ProviderInput
- type ProviderOutput
- func (o ProviderOutput) Domain() pulumi.StringPtrOutput
- func (ProviderOutput) ElementType() reflect.Type
- func (o ProviderOutput) Profile() pulumi.StringPtrOutput
- func (o ProviderOutput) Protocol() pulumi.StringPtrOutput
- func (o ProviderOutput) Region() pulumi.StringPtrOutput
- func (o ProviderOutput) SecretId() pulumi.StringPtrOutput
- func (o ProviderOutput) SecretKey() pulumi.StringPtrOutput
- func (o ProviderOutput) SecurityToken() pulumi.StringPtrOutput
- func (o ProviderOutput) SharedCredentialsDir() pulumi.StringPtrOutput
- func (o ProviderOutput) ToProviderOutput() ProviderOutput
- func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct { pulumi.ProviderResourceState // The root domain of the API request, Default is `tencentcloudapi.com`. Domain pulumi.StringPtrOutput `pulumi:"domain"` // The profile name as set in the shared credentials. It can also be sourced from the `TENCENTCLOUD_PROFILE` environment // variable. If not set, the default profile created with `tccli configure` will be used. Profile pulumi.StringPtrOutput `pulumi:"profile"` // The protocol of the API request. Valid values: `HTTP` and `HTTPS`. Default is `HTTPS`. Protocol pulumi.StringPtrOutput `pulumi:"protocol"` // This is the TencentCloud region. It must be provided, but it can also be sourced from the `TENCENTCLOUD_REGION` // environment variables. The default input value is ap-guangzhou. Region pulumi.StringPtrOutput `pulumi:"region"` // This is the TencentCloud access key. It must be provided, but it can also be sourced from the `TENCENTCLOUD_SECRET_ID` // environment variable. SecretId pulumi.StringPtrOutput `pulumi:"secretId"` // This is the TencentCloud secret key. It must be provided, but it can also be sourced from the `TENCENTCLOUD_SECRET_KEY` // environment variable. SecretKey pulumi.StringPtrOutput `pulumi:"secretKey"` // TencentCloud Security Token of temporary access credentials. It can be sourced from the `TENCENTCLOUD_SECURITY_TOKEN` // environment variable. Notice: for supported products, please refer to: [temporary key supported // products](https://intl.cloud.tencent.com/document/product/598/10588). SecurityToken pulumi.StringPtrOutput `pulumi:"securityToken"` // environment variable. If not set this defaults to ~/.tccli. SharedCredentialsDir pulumi.StringPtrOutput `pulumi:"sharedCredentialsDir"` }
The provider type for the tencentcloud package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
func NewProvider ¶
func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)
NewProvider registers a new resource with the given unique name, arguments, and options.
func (*Provider) ElementType ¶
func (*Provider) ToProviderOutput ¶
func (i *Provider) ToProviderOutput() ProviderOutput
func (*Provider) ToProviderOutputWithContext ¶
func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
type ProviderArgs ¶
type ProviderArgs struct { // The `assume_role` block. If provided, terraform will attempt to assume this role using the supplied credentials. AssumeRole ProviderAssumeRolePtrInput // The root domain of the API request, Default is `tencentcloudapi.com`. Domain pulumi.StringPtrInput // The profile name as set in the shared credentials. It can also be sourced from the `TENCENTCLOUD_PROFILE` environment // variable. If not set, the default profile created with `tccli configure` will be used. Profile pulumi.StringPtrInput // The protocol of the API request. Valid values: `HTTP` and `HTTPS`. Default is `HTTPS`. Protocol pulumi.StringPtrInput // This is the TencentCloud region. It must be provided, but it can also be sourced from the `TENCENTCLOUD_REGION` // environment variables. The default input value is ap-guangzhou. Region pulumi.StringPtrInput // This is the TencentCloud access key. It must be provided, but it can also be sourced from the `TENCENTCLOUD_SECRET_ID` // environment variable. SecretId pulumi.StringPtrInput // This is the TencentCloud secret key. It must be provided, but it can also be sourced from the `TENCENTCLOUD_SECRET_KEY` // environment variable. SecretKey pulumi.StringPtrInput // TencentCloud Security Token of temporary access credentials. It can be sourced from the `TENCENTCLOUD_SECURITY_TOKEN` // environment variable. Notice: for supported products, please refer to: [temporary key supported // products](https://intl.cloud.tencent.com/document/product/598/10588). SecurityToken pulumi.StringPtrInput // environment variable. If not set this defaults to ~/.tccli. SharedCredentialsDir pulumi.StringPtrInput }
The set of arguments for constructing a Provider resource.
func (ProviderArgs) ElementType ¶
func (ProviderArgs) ElementType() reflect.Type
type ProviderAssumeRole ¶
type ProviderAssumeRole struct { // A more restrictive policy when making the AssumeRole call. Its content must not contains `principal` elements. Notice: more syntax references, please refer to: [policies syntax logic](https://intl.cloud.tencent.com/document/product/598/10603). Policy *string `pulumi:"policy"` // The ARN of the role to assume. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_ARN`. RoleArn string `pulumi:"roleArn"` // The duration of the session when making the AssumeRole call. Its value ranges from 0 to 43200(seconds), and default is 7200 seconds. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION`. SessionDuration int `pulumi:"sessionDuration"` // The session name to use when making the AssumeRole call. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME`. SessionName string `pulumi:"sessionName"` }
type ProviderAssumeRoleArgs ¶
type ProviderAssumeRoleArgs struct { // A more restrictive policy when making the AssumeRole call. Its content must not contains `principal` elements. Notice: more syntax references, please refer to: [policies syntax logic](https://intl.cloud.tencent.com/document/product/598/10603). Policy pulumi.StringPtrInput `pulumi:"policy"` // The ARN of the role to assume. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_ARN`. RoleArn pulumi.StringInput `pulumi:"roleArn"` // The duration of the session when making the AssumeRole call. Its value ranges from 0 to 43200(seconds), and default is 7200 seconds. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION`. SessionDuration pulumi.IntInput `pulumi:"sessionDuration"` // The session name to use when making the AssumeRole call. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME`. SessionName pulumi.StringInput `pulumi:"sessionName"` }
func (ProviderAssumeRoleArgs) ElementType ¶
func (ProviderAssumeRoleArgs) ElementType() reflect.Type
func (ProviderAssumeRoleArgs) ToProviderAssumeRoleOutput ¶
func (i ProviderAssumeRoleArgs) ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput
func (ProviderAssumeRoleArgs) ToProviderAssumeRoleOutputWithContext ¶
func (i ProviderAssumeRoleArgs) ToProviderAssumeRoleOutputWithContext(ctx context.Context) ProviderAssumeRoleOutput
func (ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutput ¶
func (i ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
func (ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutputWithContext ¶
func (i ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput
type ProviderAssumeRoleInput ¶
type ProviderAssumeRoleInput interface { pulumi.Input ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput ToProviderAssumeRoleOutputWithContext(context.Context) ProviderAssumeRoleOutput }
ProviderAssumeRoleInput is an input type that accepts ProviderAssumeRoleArgs and ProviderAssumeRoleOutput values. You can construct a concrete instance of `ProviderAssumeRoleInput` via:
ProviderAssumeRoleArgs{...}
type ProviderAssumeRoleOutput ¶
type ProviderAssumeRoleOutput struct{ *pulumi.OutputState }
func (ProviderAssumeRoleOutput) ElementType ¶
func (ProviderAssumeRoleOutput) ElementType() reflect.Type
func (ProviderAssumeRoleOutput) Policy ¶
func (o ProviderAssumeRoleOutput) Policy() pulumi.StringPtrOutput
A more restrictive policy when making the AssumeRole call. Its content must not contains `principal` elements. Notice: more syntax references, please refer to: [policies syntax logic](https://intl.cloud.tencent.com/document/product/598/10603).
func (ProviderAssumeRoleOutput) RoleArn ¶
func (o ProviderAssumeRoleOutput) RoleArn() pulumi.StringOutput
The ARN of the role to assume. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_ARN`.
func (ProviderAssumeRoleOutput) SessionDuration ¶
func (o ProviderAssumeRoleOutput) SessionDuration() pulumi.IntOutput
The duration of the session when making the AssumeRole call. Its value ranges from 0 to 43200(seconds), and default is 7200 seconds. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION`.
func (ProviderAssumeRoleOutput) SessionName ¶
func (o ProviderAssumeRoleOutput) SessionName() pulumi.StringOutput
The session name to use when making the AssumeRole call. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME`.
func (ProviderAssumeRoleOutput) ToProviderAssumeRoleOutput ¶
func (o ProviderAssumeRoleOutput) ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput
func (ProviderAssumeRoleOutput) ToProviderAssumeRoleOutputWithContext ¶
func (o ProviderAssumeRoleOutput) ToProviderAssumeRoleOutputWithContext(ctx context.Context) ProviderAssumeRoleOutput
func (ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutput ¶
func (o ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
func (ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutputWithContext ¶
func (o ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput
type ProviderAssumeRolePtrInput ¶
type ProviderAssumeRolePtrInput interface { pulumi.Input ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput ToProviderAssumeRolePtrOutputWithContext(context.Context) ProviderAssumeRolePtrOutput }
ProviderAssumeRolePtrInput is an input type that accepts ProviderAssumeRoleArgs, ProviderAssumeRolePtr and ProviderAssumeRolePtrOutput values. You can construct a concrete instance of `ProviderAssumeRolePtrInput` via:
ProviderAssumeRoleArgs{...} or: nil
func ProviderAssumeRolePtr ¶
func ProviderAssumeRolePtr(v *ProviderAssumeRoleArgs) ProviderAssumeRolePtrInput
type ProviderAssumeRolePtrOutput ¶
type ProviderAssumeRolePtrOutput struct{ *pulumi.OutputState }
func (ProviderAssumeRolePtrOutput) Elem ¶
func (o ProviderAssumeRolePtrOutput) Elem() ProviderAssumeRoleOutput
func (ProviderAssumeRolePtrOutput) ElementType ¶
func (ProviderAssumeRolePtrOutput) ElementType() reflect.Type
func (ProviderAssumeRolePtrOutput) Policy ¶
func (o ProviderAssumeRolePtrOutput) Policy() pulumi.StringPtrOutput
A more restrictive policy when making the AssumeRole call. Its content must not contains `principal` elements. Notice: more syntax references, please refer to: [policies syntax logic](https://intl.cloud.tencent.com/document/product/598/10603).
func (ProviderAssumeRolePtrOutput) RoleArn ¶
func (o ProviderAssumeRolePtrOutput) RoleArn() pulumi.StringPtrOutput
The ARN of the role to assume. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_ARN`.
func (ProviderAssumeRolePtrOutput) SessionDuration ¶
func (o ProviderAssumeRolePtrOutput) SessionDuration() pulumi.IntPtrOutput
The duration of the session when making the AssumeRole call. Its value ranges from 0 to 43200(seconds), and default is 7200 seconds. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION`.
func (ProviderAssumeRolePtrOutput) SessionName ¶
func (o ProviderAssumeRolePtrOutput) SessionName() pulumi.StringPtrOutput
The session name to use when making the AssumeRole call. It can be sourced from the `TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME`.
func (ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutput ¶
func (o ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
func (ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutputWithContext ¶
func (o ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput
type ProviderInput ¶
type ProviderInput interface { pulumi.Input ToProviderOutput() ProviderOutput ToProviderOutputWithContext(ctx context.Context) ProviderOutput }
type ProviderOutput ¶
type ProviderOutput struct{ *pulumi.OutputState }
func (ProviderOutput) Domain ¶
func (o ProviderOutput) Domain() pulumi.StringPtrOutput
The root domain of the API request, Default is `tencentcloudapi.com`.
func (ProviderOutput) ElementType ¶
func (ProviderOutput) ElementType() reflect.Type
func (ProviderOutput) Profile ¶ added in v0.1.8
func (o ProviderOutput) Profile() pulumi.StringPtrOutput
The profile name as set in the shared credentials. It can also be sourced from the `TENCENTCLOUD_PROFILE` environment variable. If not set, the default profile created with `tccli configure` will be used.
func (ProviderOutput) Protocol ¶
func (o ProviderOutput) Protocol() pulumi.StringPtrOutput
The protocol of the API request. Valid values: `HTTP` and `HTTPS`. Default is `HTTPS`.
func (ProviderOutput) Region ¶
func (o ProviderOutput) Region() pulumi.StringPtrOutput
This is the TencentCloud region. It must be provided, but it can also be sourced from the `TENCENTCLOUD_REGION` environment variables. The default input value is ap-guangzhou.
func (ProviderOutput) SecretId ¶
func (o ProviderOutput) SecretId() pulumi.StringPtrOutput
This is the TencentCloud access key. It must be provided, but it can also be sourced from the `TENCENTCLOUD_SECRET_ID` environment variable.
func (ProviderOutput) SecretKey ¶
func (o ProviderOutput) SecretKey() pulumi.StringPtrOutput
This is the TencentCloud secret key. It must be provided, but it can also be sourced from the `TENCENTCLOUD_SECRET_KEY` environment variable.
func (ProviderOutput) SecurityToken ¶
func (o ProviderOutput) SecurityToken() pulumi.StringPtrOutput
TencentCloud Security Token of temporary access credentials. It can be sourced from the `TENCENTCLOUD_SECURITY_TOKEN` environment variable. Notice: for supported products, please refer to: [temporary key supported products](https://intl.cloud.tencent.com/document/product/598/10588).
func (ProviderOutput) SharedCredentialsDir ¶ added in v0.1.8
func (o ProviderOutput) SharedCredentialsDir() pulumi.StringPtrOutput
The directory of the shared credentials. It can also be sourced from the `TENCENTCLOUD_SHARED_CREDENTIALS_DIR` environment variable. If not set this defaults to ~/.tccli.
func (ProviderOutput) ToProviderOutput ¶
func (o ProviderOutput) ToProviderOutput() ProviderOutput
func (ProviderOutput) ToProviderOutputWithContext ¶
func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput