Class CfnDistributionProps
Properties for defining a CfnDistribution
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public class CfnDistributionProps : Object, ICfnDistributionProps
Syntax (vb)
Public Class CfnDistributionProps
Inherits Object
Implements ICfnDistributionProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lightsail;
var cfnDistributionProps = new CfnDistributionProps {
BundleId = "bundleId",
DefaultCacheBehavior = new CacheBehaviorProperty {
Behavior = "behavior"
},
DistributionName = "distributionName",
Origin = new InputOriginProperty {
Name = "name",
ProtocolPolicy = "protocolPolicy",
RegionName = "regionName"
},
// the properties below are optional
CacheBehaviors = new [] { new CacheBehaviorPerPathProperty {
Behavior = "behavior",
Path = "path"
} },
CacheBehaviorSettings = new CacheSettingsProperty {
AllowedHttpMethods = "allowedHttpMethods",
CachedHttpMethods = "cachedHttpMethods",
DefaultTtl = 123,
ForwardedCookies = new CookieObjectProperty {
CookiesAllowList = new [] { "cookiesAllowList" },
Option = "option"
},
ForwardedHeaders = new HeaderObjectProperty {
HeadersAllowList = new [] { "headersAllowList" },
Option = "option"
},
ForwardedQueryStrings = new QueryStringObjectProperty {
Option = false,
QueryStringsAllowList = new [] { "queryStringsAllowList" }
},
MaximumTtl = 123,
MinimumTtl = 123
},
CertificateName = "certificateName",
IpAddressType = "ipAddressType",
IsEnabled = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnDistributionProps() |
Properties
BundleId | The ID of the bundle applied to the distribution. |
CacheBehaviors | An array of objects that describe the per-path cache behavior of the distribution. |
CacheBehaviorSettings | An object that describes the cache behavior settings of the distribution. |
CertificateName | The name of the SSL/TLS certificate attached to the distribution. |
DefaultCacheBehavior | An object that describes the default cache behavior of the distribution. |
DistributionName | The name of the distribution. |
IpAddressType | The IP address type of the distribution. |
IsEnabled | A Boolean value indicating whether the distribution is enabled. |
Origin | An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer. |
Tags | An array of key-value pairs to apply to this resource. |
Constructors
CfnDistributionProps()
public CfnDistributionProps()
Properties
BundleId
The ID of the bundle applied to the distribution.
public string BundleId { get; set; }
Property Value
System.String
Remarks
CacheBehaviors
An array of objects that describe the per-path cache behavior of the distribution.
public object CacheBehaviors { get; set; }
Property Value
System.Object
Remarks
CacheBehaviorSettings
An object that describes the cache behavior settings of the distribution.
public object CacheBehaviorSettings { get; set; }
Property Value
System.Object
Remarks
CertificateName
The name of the SSL/TLS certificate attached to the distribution.
public string CertificateName { get; set; }
Property Value
System.String
Remarks
DefaultCacheBehavior
An object that describes the default cache behavior of the distribution.
public object DefaultCacheBehavior { get; set; }
Property Value
System.Object
Remarks
DistributionName
The name of the distribution.
public string DistributionName { get; set; }
Property Value
System.String
Remarks
IpAddressType
The IP address type of the distribution.
public string IpAddressType { get; set; }
Property Value
System.String
Remarks
The possible values are ipv4
for IPv4 only, and dualstack
for IPv4 and IPv6.
IsEnabled
A Boolean value indicating whether the distribution is enabled.
public object IsEnabled { get; set; }
Property Value
System.Object
Remarks
Origin
An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
public object Origin { get; set; }
Property Value
System.Object
Remarks
The distribution pulls, caches, and serves content from the origin.
Tags
An array of key-value pairs to apply to this resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Tag in the AWS CloudFormation User Guide .
The Value
of Tags
is optional for Lightsail resources.