Updates a distribution tenant¶

Description¶

Updates a distribution tenant.

Usage¶

cloudfront_update_distribution_tenant(Id, DistributionId, Domains,
  Customizations, Parameters, ConnectionGroupId, IfMatch,
  ManagedCertificateRequest, Enabled)

Arguments¶

Id

[required] The ID of the distribution tenant.
DistributionId

The ID for the multi-tenant distribution.
Domains

The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.
Customizations

Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
Parameters

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
ConnectionGroupId

The ID of the target connection group.
IfMatch

[required] The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the get_distribution_tenant API operation.
ManagedCertificateRequest

An object that contains the CloudFront managed ACM certificate request.
Enabled

Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.

Value¶

A list with the following syntax:

list(
  DistributionTenant = list(
    Id = "string",
    DistributionId = "string",
    Name = "string",
    Arn = "string",
    Domains = list(
      list(
        Domain = "string",
        Status = "active"|"inactive"
      )
    ),
    Tags = list(
      Items = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    ),
    Customizations = list(
      WebAcl = list(
        Action = "override"|"disable",
        Arn = "string"
      ),
      Certificate = list(
        Arn = "string"
      ),
      GeoRestrictions = list(
        RestrictionType = "blacklist"|"whitelist"|"none",
        Locations = list(
          "string"
        )
      )
    ),
    Parameters = list(
      list(
        Name = "string",
        Value = "string"
      )
    ),
    ConnectionGroupId = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    Enabled = TRUE|FALSE,
    Status = "string"
  ),
  ETag = "string"
)

Request syntax¶

svc$update_distribution_tenant(
  Id = "string",
  DistributionId = "string",
  Domains = list(
    list(
      Domain = "string"
    )
  ),
  Customizations = list(
    WebAcl = list(
      Action = "override"|"disable",
      Arn = "string"
    ),
    Certificate = list(
      Arn = "string"
    ),
    GeoRestrictions = list(
      RestrictionType = "blacklist"|"whitelist"|"none",
      Locations = list(
        "string"
      )
    )
  ),
  Parameters = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  ConnectionGroupId = "string",
  IfMatch = "string",
  ManagedCertificateRequest = list(
    ValidationTokenHost = "cloudfront"|"self-hosted",
    PrimaryDomainName = "string",
    CertificateTransparencyLoggingPreference = "enabled"|"disabled"
  ),
  Enabled = TRUE|FALSE
)