CdnOriginGroup

gcore 2.0.0-alpha.6, Apr 27 26

Viewing docs for gcore 2.0.0-alpha.6
published on Monday, Apr 27, 2026 by g-core

Import

$ pulumi import gcore:index/cdnOriginGroup:CdnOriginGroup example '<origin_group_id>'

Create CdnOriginGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CdnOriginGroup(name: string, args: CdnOriginGroupArgs, opts?: CustomResourceOptions);

@overload
def CdnOriginGroup(resource_name: str,
                   args: CdnOriginGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CdnOriginGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   sources: Optional[Sequence[CdnOriginGroupSourceArgs]] = None,
                   name: Optional[str] = None,
                   proxy_next_upstreams: Optional[Sequence[str]] = None,
                   s3_credentials_version: Optional[float] = None,
                   use_next: Optional[bool] = None)

func NewCdnOriginGroup(ctx *Context, name string, args CdnOriginGroupArgs, opts ...ResourceOption) (*CdnOriginGroup, error)

public CdnOriginGroup(string name, CdnOriginGroupArgs args, CustomResourceOptions? opts = null)

public CdnOriginGroup(String name, CdnOriginGroupArgs args)
public CdnOriginGroup(String name, CdnOriginGroupArgs args, CustomResourceOptions options)

type: gcore:CdnOriginGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args CdnOriginGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CdnOriginGroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CdnOriginGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CdnOriginGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CdnOriginGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var cdnOriginGroupResource = new Gcore.CdnOriginGroup("cdnOriginGroupResource", new()
{
    Sources = new[]
    {
        new Gcore.Inputs.CdnOriginGroupSourceArgs
        {
            Backup = false,
            Config = new Gcore.Inputs.CdnOriginGroupSourceConfigArgs
            {
                S3AccessKeyId = "string",
                S3BucketName = "string",
                S3SecretAccessKey = "string",
                S3Type = "string",
                S3AuthType = "string",
                S3Region = "string",
                S3StorageHostname = "string",
            },
            Enabled = false,
            HostHeaderOverride = "string",
            OriginType = "string",
            Source = "string",
            Tag = "string",
        },
    },
    Name = "string",
    ProxyNextUpstreams = new[]
    {
        "string",
    },
    S3CredentialsVersion = 0,
    UseNext = false,
});

example, err := gcore.NewCdnOriginGroup(ctx, "cdnOriginGroupResource", &gcore.CdnOriginGroupArgs{
	Sources: gcore.CdnOriginGroupSourceArray{
		&gcore.CdnOriginGroupSourceArgs{
			Backup: pulumi.Bool(false),
			Config: &gcore.CdnOriginGroupSourceConfigArgs{
				S3AccessKeyId:     pulumi.String("string"),
				S3BucketName:      pulumi.String("string"),
				S3SecretAccessKey: pulumi.String("string"),
				S3Type:            pulumi.String("string"),
				S3AuthType:        pulumi.String("string"),
				S3Region:          pulumi.String("string"),
				S3StorageHostname: pulumi.String("string"),
			},
			Enabled:            pulumi.Bool(false),
			HostHeaderOverride: pulumi.String("string"),
			OriginType:         pulumi.String("string"),
			Source:             pulumi.String("string"),
			Tag:                pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	ProxyNextUpstreams: pulumi.StringArray{
		pulumi.String("string"),
	},
	S3CredentialsVersion: pulumi.Float64(0),
	UseNext:              pulumi.Bool(false),
})

var cdnOriginGroupResource = new CdnOriginGroup("cdnOriginGroupResource", CdnOriginGroupArgs.builder()
    .sources(CdnOriginGroupSourceArgs.builder()
        .backup(false)
        .config(CdnOriginGroupSourceConfigArgs.builder()
            .s3AccessKeyId("string")
            .s3BucketName("string")
            .s3SecretAccessKey("string")
            .s3Type("string")
            .s3AuthType("string")
            .s3Region("string")
            .s3StorageHostname("string")
            .build())
        .enabled(false)
        .hostHeaderOverride("string")
        .originType("string")
        .source("string")
        .tag("string")
        .build())
    .name("string")
    .proxyNextUpstreams("string")
    .s3CredentialsVersion(0.0)
    .useNext(false)
    .build());

cdn_origin_group_resource = gcore.CdnOriginGroup("cdnOriginGroupResource",
    sources=[{
        "backup": False,
        "config": {
            "s3_access_key_id": "string",
            "s3_bucket_name": "string",
            "s3_secret_access_key": "string",
            "s3_type": "string",
            "s3_auth_type": "string",
            "s3_region": "string",
            "s3_storage_hostname": "string",
        },
        "enabled": False,
        "host_header_override": "string",
        "origin_type": "string",
        "source": "string",
        "tag": "string",
    }],
    name="string",
    proxy_next_upstreams=["string"],
    s3_credentials_version=float(0),
    use_next=False)

const cdnOriginGroupResource = new gcore.CdnOriginGroup("cdnOriginGroupResource", {
    sources: [{
        backup: false,
        config: {
            s3AccessKeyId: "string",
            s3BucketName: "string",
            s3SecretAccessKey: "string",
            s3Type: "string",
            s3AuthType: "string",
            s3Region: "string",
            s3StorageHostname: "string",
        },
        enabled: false,
        hostHeaderOverride: "string",
        originType: "string",
        source: "string",
        tag: "string",
    }],
    name: "string",
    proxyNextUpstreams: ["string"],
    s3CredentialsVersion: 0,
    useNext: false,
});

type: gcore:CdnOriginGroup
properties:
    name: string
    proxyNextUpstreams:
        - string
    s3CredentialsVersion: 0
    sources:
        - backup: false
          config:
            s3AccessKeyId: string
            s3AuthType: string
            s3BucketName: string
            s3Region: string
            s3SecretAccessKey: string
            s3StorageHostname: string
            s3Type: string
          enabled: false
          hostHeaderOverride: string
          originType: string
          source: string
          tag: string
    useNext: false

CdnOriginGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CdnOriginGroup resource accepts the following input properties:

Sources List<CdnOriginGroupSource>

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

Name string

Origin group name.

ProxyNextUpstreams List<string>

Defines cases when the request should be passed on to the next origin.

S3CredentialsVersion double

UseNext bool

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

Sources []CdnOriginGroupSourceArgs

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

Name string

Origin group name.

ProxyNextUpstreams []string

Defines cases when the request should be passed on to the next origin.

S3CredentialsVersion float64

UseNext bool

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

sources List<CdnOriginGroupSource>

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

name String

Origin group name.

proxyNextUpstreams List<String>

Defines cases when the request should be passed on to the next origin.

s3CredentialsVersion Double

useNext Boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

sources CdnOriginGroupSource[]

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

name string

Origin group name.

proxyNextUpstreams string[]

Defines cases when the request should be passed on to the next origin.

s3CredentialsVersion number

useNext boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

sources Sequence[CdnOriginGroupSourceArgs]

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

name str

Origin group name.

proxy_next_upstreams Sequence[str]

Defines cases when the request should be passed on to the next origin.

s3_credentials_version float

use_next bool

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

sources List<Property Map>

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

name String

Origin group name.

proxyNextUpstreams List<String>

Defines cases when the request should be passed on to the next origin.

s3CredentialsVersion Number

useNext Boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

Outputs

All input properties are implicitly available as output properties. Additionally, the CdnOriginGroup resource produces the following output properties:

CdnOriginGroupId double

Origin group ID.

HasRelatedResources bool

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

Id string

The provider-assigned unique ID for this managed resource.

CdnOriginGroupId float64

Origin group ID.

HasRelatedResources bool

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

Id string

The provider-assigned unique ID for this managed resource.

cdnOriginGroupId Double

Origin group ID.

hasRelatedResources Boolean

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

id String

The provider-assigned unique ID for this managed resource.

cdnOriginGroupId number

Origin group ID.

hasRelatedResources boolean

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

id string

The provider-assigned unique ID for this managed resource.

cdn_origin_group_id float

Origin group ID.

has_related_resources bool

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

id str

The provider-assigned unique ID for this managed resource.

cdnOriginGroupId Number

Origin group ID.

hasRelatedResources Boolean

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing CdnOriginGroup Resource

Get an existing CdnOriginGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CdnOriginGroupState, opts?: CustomResourceOptions): CdnOriginGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cdn_origin_group_id: Optional[float] = None,
        has_related_resources: Optional[bool] = None,
        name: Optional[str] = None,
        proxy_next_upstreams: Optional[Sequence[str]] = None,
        s3_credentials_version: Optional[float] = None,
        sources: Optional[Sequence[CdnOriginGroupSourceArgs]] = None,
        use_next: Optional[bool] = None) -> CdnOriginGroup

func GetCdnOriginGroup(ctx *Context, name string, id IDInput, state *CdnOriginGroupState, opts ...ResourceOption) (*CdnOriginGroup, error)

public static CdnOriginGroup Get(string name, Input<string> id, CdnOriginGroupState? state, CustomResourceOptions? opts = null)

public static CdnOriginGroup get(String name, Output<String> id, CdnOriginGroupState state, CustomResourceOptions options)

resources:  _:    type: gcore:CdnOriginGroup    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CdnOriginGroupId double

Origin group ID.

HasRelatedResources bool

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

Name string

Origin group name.

ProxyNextUpstreams List<string>

Defines cases when the request should be passed on to the next origin.

S3CredentialsVersion double

Sources List<CdnOriginGroupSource>

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

UseNext bool

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

CdnOriginGroupId float64

Origin group ID.

HasRelatedResources bool

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

Name string

Origin group name.

ProxyNextUpstreams []string

Defines cases when the request should be passed on to the next origin.

S3CredentialsVersion float64

Sources []CdnOriginGroupSourceArgs

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

UseNext bool

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

cdnOriginGroupId Double

Origin group ID.

hasRelatedResources Boolean

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

name String

Origin group name.

proxyNextUpstreams List<String>

Defines cases when the request should be passed on to the next origin.

s3CredentialsVersion Double

sources List<CdnOriginGroupSource>

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

useNext Boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

cdnOriginGroupId number

Origin group ID.

hasRelatedResources boolean

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

name string

Origin group name.

proxyNextUpstreams string[]

Defines cases when the request should be passed on to the next origin.

s3CredentialsVersion number

sources CdnOriginGroupSource[]

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

useNext boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

cdn_origin_group_id float

Origin group ID.

has_related_resources bool

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

name str

Origin group name.

proxy_next_upstreams Sequence[str]

Defines cases when the request should be passed on to the next origin.

s3_credentials_version float

sources Sequence[CdnOriginGroupSourceArgs]

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

use_next bool

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

cdnOriginGroupId Number

Origin group ID.

hasRelatedResources Boolean

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

name String

Origin group name.

proxyNextUpstreams List<String>

Defines cases when the request should be passed on to the next origin.

s3CredentialsVersion Number

sources List<Property Map>

List of origin sources. Each source can be a host origin (with source field) or an S3 origin (with origin_type = "s3" and a config block).

useNext Boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

Supporting Types

CdnOriginGroupSource, CdnOriginGroupSourceArgs

Backup bool

Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.

Config CdnOriginGroupSourceConfig

S3 storage configuration. Required when origin_type is s3.

Enabled bool

Enables or disables an origin source in the origin group.

Possible values:

true - Origin is enabled and the CDN uses it to pull content.
false - Origin is disabled and the CDN does not use it to pull content.

Origin group must contain at least one enabled origin.

Default value is true.

HostHeaderOverride string

Per-origin Host header override. When set, the CDN sends this value as the Host header when requesting content from this origin instead of the default.

OriginType string

Origin type.

Possible values:

host - A source server or endpoint from which content is fetched.
s3 - S3 storage with either AWS v4 authentication or public access. Available values: "host", "s3".

Source string

IP address or domain name of the origin and the port, if custom port is used.

Tag string

Tag for the origin source.

Backup bool

Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.

Config CdnOriginGroupSourceConfig

S3 storage configuration. Required when origin_type is s3.

Enabled bool

Enables or disables an origin source in the origin group.

Possible values:

true - Origin is enabled and the CDN uses it to pull content.
false - Origin is disabled and the CDN does not use it to pull content.

Origin group must contain at least one enabled origin.

Default value is true.

HostHeaderOverride string

Per-origin Host header override. When set, the CDN sends this value as the Host header when requesting content from this origin instead of the default.

OriginType string

Origin type.

Possible values:

host - A source server or endpoint from which content is fetched.
s3 - S3 storage with either AWS v4 authentication or public access. Available values: "host", "s3".

Source string

IP address or domain name of the origin and the port, if custom port is used.

Tag string

Tag for the origin source.

backup Boolean

Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.

config CdnOriginGroupSourceConfig

S3 storage configuration. Required when origin_type is s3.

enabled Boolean

Enables or disables an origin source in the origin group.

Possible values:

true - Origin is enabled and the CDN uses it to pull content.
false - Origin is disabled and the CDN does not use it to pull content.

Origin group must contain at least one enabled origin.

Default value is true.

hostHeaderOverride String

Per-origin Host header override. When set, the CDN sends this value as the Host header when requesting content from this origin instead of the default.

originType String

Origin type.

Possible values:

host - A source server or endpoint from which content is fetched.
s3 - S3 storage with either AWS v4 authentication or public access. Available values: "host", "s3".

source String

IP address or domain name of the origin and the port, if custom port is used.

tag String

Tag for the origin source.

backup boolean

Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.

config CdnOriginGroupSourceConfig

S3 storage configuration. Required when origin_type is s3.

enabled boolean

Enables or disables an origin source in the origin group.

Possible values:

true - Origin is enabled and the CDN uses it to pull content.
false - Origin is disabled and the CDN does not use it to pull content.

Origin group must contain at least one enabled origin.

Default value is true.

hostHeaderOverride string

Per-origin Host header override. When set, the CDN sends this value as the Host header when requesting content from this origin instead of the default.

originType string

Origin type.

Possible values:

host - A source server or endpoint from which content is fetched.
s3 - S3 storage with either AWS v4 authentication or public access. Available values: "host", "s3".

source string

IP address or domain name of the origin and the port, if custom port is used.

tag string

Tag for the origin source.

backup bool

Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.

config CdnOriginGroupSourceConfig

S3 storage configuration. Required when origin_type is s3.

enabled bool

Enables or disables an origin source in the origin group.

Possible values:

true - Origin is enabled and the CDN uses it to pull content.
false - Origin is disabled and the CDN does not use it to pull content.

Origin group must contain at least one enabled origin.

Default value is true.

host_header_override str

Per-origin Host header override. When set, the CDN sends this value as the Host header when requesting content from this origin instead of the default.

origin_type str

Origin type.

Possible values:

host - A source server or endpoint from which content is fetched.
s3 - S3 storage with either AWS v4 authentication or public access. Available values: "host", "s3".

source str

IP address or domain name of the origin and the port, if custom port is used.

tag str

Tag for the origin source.

backup Boolean

Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.

config Property Map

S3 storage configuration. Required when origin_type is s3.

enabled Boolean

Enables or disables an origin source in the origin group.

Possible values:

true - Origin is enabled and the CDN uses it to pull content.
false - Origin is disabled and the CDN does not use it to pull content.

Origin group must contain at least one enabled origin.

Default value is true.

hostHeaderOverride String

Per-origin Host header override. When set, the CDN sends this value as the Host header when requesting content from this origin instead of the default.

originType String

Origin type.

Possible values:

host - A source server or endpoint from which content is fetched.
s3 - S3 storage with either AWS v4 authentication or public access. Available values: "host", "s3".

source String

IP address or domain name of the origin and the port, if custom port is used.

tag String

Tag for the origin source.

CdnOriginGroupSourceConfig, CdnOriginGroupSourceConfigArgs

S3AccessKeyId string

Access key ID for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

S3BucketName string

S3 bucket name.

S3SecretAccessKey string

Secret access key for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

Restrictions:

Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
From 16 to 255 characters.

S3Type string

Storage type compatible with S3.

Possible values:

amazon - AWS S3 storage.
other - Other (not AWS) S3 compatible storage. Available values: "amazon", "other".

S3AuthType string

S3 authentication type.

S3Region string

S3 storage region.

The parameter is required if s3_type is amazon.

S3StorageHostname string

S3 storage hostname.

The parameter is required if s3_type is other.

S3AccessKeyId string

Access key ID for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

S3BucketName string

S3 bucket name.

S3SecretAccessKey string

Secret access key for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

Restrictions:

Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
From 16 to 255 characters.

S3Type string

Storage type compatible with S3.

Possible values:

amazon - AWS S3 storage.
other - Other (not AWS) S3 compatible storage. Available values: "amazon", "other".

S3AuthType string

S3 authentication type.

S3Region string

S3 storage region.

The parameter is required if s3_type is amazon.

S3StorageHostname string

S3 storage hostname.

The parameter is required if s3_type is other.

s3AccessKeyId String

Access key ID for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

s3BucketName String

S3 bucket name.

s3SecretAccessKey String

Secret access key for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

Restrictions:

Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
From 16 to 255 characters.

s3Type String

Storage type compatible with S3.

Possible values:

amazon - AWS S3 storage.
other - Other (not AWS) S3 compatible storage. Available values: "amazon", "other".

s3AuthType String

S3 authentication type.

s3Region String

S3 storage region.

The parameter is required if s3_type is amazon.

s3StorageHostname String

S3 storage hostname.

The parameter is required if s3_type is other.

s3AccessKeyId string

Access key ID for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

s3BucketName string

S3 bucket name.

s3SecretAccessKey string

Secret access key for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

Restrictions:

Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
From 16 to 255 characters.

s3Type string

Storage type compatible with S3.

Possible values:

amazon - AWS S3 storage.
other - Other (not AWS) S3 compatible storage. Available values: "amazon", "other".

s3AuthType string

S3 authentication type.

s3Region string

S3 storage region.

The parameter is required if s3_type is amazon.

s3StorageHostname string

S3 storage hostname.

The parameter is required if s3_type is other.

s3_access_key_id str

Access key ID for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

s3_bucket_name str

S3 bucket name.

s3_secret_access_key str

Secret access key for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

Restrictions:

Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
From 16 to 255 characters.

s3_type str

Storage type compatible with S3.

Possible values:

amazon - AWS S3 storage.
other - Other (not AWS) S3 compatible storage. Available values: "amazon", "other".

s3_auth_type str

S3 authentication type.

s3_region str

S3 storage region.

The parameter is required if s3_type is amazon.

s3_storage_hostname str

S3 storage hostname.

The parameter is required if s3_type is other.

s3AccessKeyId String

Access key ID for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

s3BucketName String

S3 bucket name.

s3SecretAccessKey String

Secret access key for the S3 account. This is a write-only field — it will be sent to the API but never stored in state. Increment s3_credentials_version to force re-send.

Restrictions: