AWS Native v0.54.0, Mar 21 23
AWS Native v0.54.0, Mar 21 23
aws-native.cloudfront.getDistribution
Resource Type definition for AWS::CloudFront::Distribution
Using getDistribution
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDistribution(args: GetDistributionArgs, opts?: InvokeOptions): Promise<GetDistributionResult>
function getDistributionOutput(args: GetDistributionOutputArgs, opts?: InvokeOptions): Output<GetDistributionResult>
def get_distribution(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDistributionResult
def get_distribution_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDistributionResult]
func LookupDistribution(ctx *Context, args *LookupDistributionArgs, opts ...InvokeOption) (*LookupDistributionResult, error)
func LookupDistributionOutput(ctx *Context, args *LookupDistributionOutputArgs, opts ...InvokeOption) LookupDistributionResultOutput
> Note: This function is named LookupDistribution
in the Go SDK.
public static class GetDistribution
{
public static Task<GetDistributionResult> InvokeAsync(GetDistributionArgs args, InvokeOptions? opts = null)
public static Output<GetDistributionResult> Invoke(GetDistributionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDistributionResult> getDistribution(GetDistributionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:cloudfront:getDistribution
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- Id string
- id String
- id string
- id str
- id String
getDistribution Result
The following output properties are available:
- distribution
Config Property Map - domain
Name String - id String
- List<Property Map>
Supporting Types
DistributionCacheBehavior
- Path
Pattern string - Target
Origin stringId - Viewer
Protocol stringPolicy - Allowed
Methods List<string> - Cache
Policy stringId - Cached
Methods List<string> - Compress bool
- Default
TTL double - Field
Level stringEncryption Id - Forwarded
Values Pulumi.Aws Native. Cloud Front. Inputs. Distribution Forwarded Values - Function
Associations List<Pulumi.Aws Native. Cloud Front. Inputs. Distribution Function Association> - Lambda
Function List<Pulumi.Associations Aws Native. Cloud Front. Inputs. Distribution Lambda Function Association> - Max
TTL double - Min
TTL double - Origin
Request stringPolicy Id - Realtime
Log stringConfig Arn - Response
Headers stringPolicy Id - Smooth
Streaming bool - Trusted
Key List<string>Groups - Trusted
Signers List<string>
- Path
Pattern string - Target
Origin stringId - Viewer
Protocol stringPolicy - Allowed
Methods []string - Cache
Policy stringId - Cached
Methods []string - Compress bool
- Default
TTL float64 - Field
Level stringEncryption Id - Forwarded
Values DistributionForwarded Values - Function
Associations []DistributionFunction Association - Lambda
Function []DistributionAssociations Lambda Function Association - Max
TTL float64 - Min
TTL float64 - Origin
Request stringPolicy Id - Realtime
Log stringConfig Arn - Response
Headers stringPolicy Id - Smooth
Streaming bool - Trusted
Key []stringGroups - Trusted
Signers []string
- path
Pattern String - target
Origin StringId - viewer
Protocol StringPolicy - allowed
Methods List<String> - cache
Policy StringId - cached
Methods List<String> - compress Boolean
- default
TTL Double - field
Level StringEncryption Id - forwarded
Values DistributionForwarded Values - function
Associations List<DistributionFunction Association> - lambda
Function List<DistributionAssociations Lambda Function Association> - max
TTL Double - min
TTL Double - origin
Request StringPolicy Id - realtime
Log StringConfig Arn - response
Headers StringPolicy Id - smooth
Streaming Boolean - trusted
Key List<String>Groups - trusted
Signers List<String>
- path
Pattern string - target
Origin stringId - viewer
Protocol stringPolicy - allowed
Methods string[] - cache
Policy stringId - cached
Methods string[] - compress boolean
- default
TTL number - field
Level stringEncryption Id - forwarded
Values DistributionForwarded Values - function
Associations DistributionFunction Association[] - lambda
Function DistributionAssociations Lambda Function Association[] - max
TTL number - min
TTL number - origin
Request stringPolicy Id - realtime
Log stringConfig Arn - response
Headers stringPolicy Id - smooth
Streaming boolean - trusted
Key string[]Groups - trusted
Signers string[]
- path_
pattern str - target_
origin_ strid - viewer_
protocol_ strpolicy - allowed_
methods Sequence[str] - cache_
policy_ strid - cached_
methods Sequence[str] - compress bool
- default_
ttl float - field_
level_ strencryption_ id - forwarded_
values DistributionForwarded Values - function_
associations Sequence[DistributionFunction Association] - lambda_
function_ Sequence[Distributionassociations Lambda Function Association] - max_
ttl float - min_
ttl float - origin_
request_ strpolicy_ id - realtime_
log_ strconfig_ arn - response_
headers_ strpolicy_ id - smooth_
streaming bool - trusted_
key_ Sequence[str]groups - trusted_
signers Sequence[str]
- path
Pattern String - target
Origin StringId - viewer
Protocol StringPolicy - allowed
Methods List<String> - cache
Policy StringId - cached
Methods List<String> - compress Boolean
- default
TTL Number - field
Level StringEncryption Id - forwarded
Values Property Map - function
Associations List<Property Map> - lambda
Function List<Property Map>Associations - max
TTL Number - min
TTL Number - origin
Request StringPolicy Id - realtime
Log StringConfig Arn - response
Headers StringPolicy Id - smooth
Streaming Boolean - trusted
Key List<String>Groups - trusted
Signers List<String>
DistributionConfig
- Default
Cache Pulumi.Behavior Aws Native. Cloud Front. Inputs. Distribution Default Cache Behavior - Enabled bool
- Aliases List<string>
- CNAMEs List<string>
- Cache
Behaviors List<Pulumi.Aws Native. Cloud Front. Inputs. Distribution Cache Behavior> - Comment string
- Continuous
Deployment stringPolicy Id - Custom
Error List<Pulumi.Responses Aws Native. Cloud Front. Inputs. Distribution Custom Error Response> - Custom
Origin Pulumi.Aws Native. Cloud Front. Inputs. Distribution Legacy Custom Origin - Default
Root stringObject - Http
Version string - IPV6Enabled bool
- Logging
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Logging - Origin
Groups Pulumi.Aws Native. Cloud Front. Inputs. Distribution Origin Groups - Origins
List<Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Origin> - Price
Class string - Restrictions
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Restrictions - S3Origin
Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Legacy S3Origin - Staging bool
- Viewer
Certificate Pulumi.Aws Native. Cloud Front. Inputs. Distribution Viewer Certificate - Web
ACLId string
- Default
Cache DistributionBehavior Default Cache Behavior - Enabled bool
- Aliases []string
- CNAMEs []string
- Cache
Behaviors []DistributionCache Behavior - Comment string
- Continuous
Deployment stringPolicy Id - Custom
Error []DistributionResponses Custom Error Response - Custom
Origin DistributionLegacy Custom Origin - Default
Root stringObject - Http
Version string - IPV6Enabled bool
- Logging
Distribution
Logging - Origin
Groups DistributionOrigin Groups - Origins
[]Distribution
Origin - Price
Class string - Restrictions
Distribution
Restrictions - S3Origin
Distribution
Legacy S3Origin - Staging bool
- Viewer
Certificate DistributionViewer Certificate - Web
ACLId string
- default
Cache DistributionBehavior Default Cache Behavior - enabled Boolean
- aliases List<String>
- c
NAMEs List<String> - cache
Behaviors List<DistributionCache Behavior> - comment String
- continuous
Deployment StringPolicy Id - custom
Error List<DistributionResponses Custom Error Response> - custom
Origin DistributionLegacy Custom Origin - default
Root StringObject - http
Version String - i
PV6Enabled Boolean - logging
Distribution
Logging - origin
Groups DistributionOrigin Groups - origins
List<Distribution
Origin> - price
Class String - restrictions
Distribution
Restrictions - s3Origin
Distribution
Legacy S3Origin - staging Boolean
- viewer
Certificate DistributionViewer Certificate - web
ACLId String
- default
Cache DistributionBehavior Default Cache Behavior - enabled boolean
- aliases string[]
- c
NAMEs string[] - cache
Behaviors DistributionCache Behavior[] - comment string
- continuous
Deployment stringPolicy Id - custom
Error DistributionResponses Custom Error Response[] - custom
Origin DistributionLegacy Custom Origin - default
Root stringObject - http
Version string - i
PV6Enabled boolean - logging
Distribution
Logging - origin
Groups DistributionOrigin Groups - origins
Distribution
Origin[] - price
Class string - restrictions
Distribution
Restrictions - s3Origin
Distribution
Legacy S3Origin - staging boolean
- viewer
Certificate DistributionViewer Certificate - web
ACLId string
- default_
cache_ Distributionbehavior Default Cache Behavior - enabled bool
- aliases Sequence[str]
- c_
names Sequence[str] - cache_
behaviors Sequence[DistributionCache Behavior] - comment str
- continuous_
deployment_ strpolicy_ id - custom_
error_ Sequence[Distributionresponses Custom Error Response] - custom_
origin DistributionLegacy Custom Origin - default_
root_ strobject - http_
version str - i_
pv6_ boolenabled - logging
Distribution
Logging - origin_
groups DistributionOrigin Groups - origins
Sequence[Distribution
Origin] - price_
class str - restrictions
Distribution
Restrictions - s3_
origin DistributionLegacy S3Origin - staging bool
- viewer_
certificate DistributionViewer Certificate - web_
acl_ strid
- default
Cache Property MapBehavior - enabled Boolean
- aliases List<String>
- c
NAMEs List<String> - cache
Behaviors List<Property Map> - comment String
- continuous
Deployment StringPolicy Id - custom
Error List<Property Map>Responses - custom
Origin Property Map - default
Root StringObject - http
Version String - i
PV6Enabled Boolean - logging Property Map
- origin
Groups Property Map - origins List<Property Map>
- price
Class String - restrictions Property Map
- s3Origin Property Map
- staging Boolean
- viewer
Certificate Property Map - web
ACLId String
DistributionCookies
- Forward string
- Whitelisted
Names List<string>
- Forward string
- Whitelisted
Names []string
- forward String
- whitelisted
Names List<String>
- forward string
- whitelisted
Names string[]
- forward str
- whitelisted_
names Sequence[str]
- forward String
- whitelisted
Names List<String>
DistributionCustomErrorResponse
- Error
Code int - Error
Caching doubleMin TTL - Response
Code int - Response
Page stringPath
- Error
Code int - Error
Caching float64Min TTL - Response
Code int - Response
Page stringPath
- error
Code Integer - error
Caching DoubleMin TTL - response
Code Integer - response
Page StringPath
- error
Code number - error
Caching numberMin TTL - response
Code number - response
Page stringPath
- error_
code int - error_
caching_ floatmin_ ttl - response_
code int - response_
page_ strpath
- error
Code Number - error
Caching NumberMin TTL - response
Code Number - response
Page StringPath
DistributionCustomOriginConfig
- Origin
Protocol stringPolicy - HTTPPort int
- HTTPSPort int
- Origin
Keepalive intTimeout - Origin
Read intTimeout - Origin
SSLProtocols List<string>
- Origin
Protocol stringPolicy - HTTPPort int
- HTTPSPort int
- Origin
Keepalive intTimeout - Origin
Read intTimeout - Origin
SSLProtocols []string
- origin
Protocol StringPolicy - h
TTPPort Integer - h
TTPSPort Integer - origin
Keepalive IntegerTimeout - origin
Read IntegerTimeout - origin
SSLProtocols List<String>
- origin
Protocol stringPolicy - h
TTPPort number - h
TTPSPort number - origin
Keepalive numberTimeout - origin
Read numberTimeout - origin
SSLProtocols string[]
- origin_
protocol_ strpolicy - h_
ttp_ intport - h_
ttps_ intport - origin_
keepalive_ inttimeout - origin_
read_ inttimeout - origin_
ssl_ Sequence[str]protocols
- origin
Protocol StringPolicy - h
TTPPort Number - h
TTPSPort Number - origin
Keepalive NumberTimeout - origin
Read NumberTimeout - origin
SSLProtocols List<String>
DistributionDefaultCacheBehavior
- Target
Origin stringId - Viewer
Protocol stringPolicy - Allowed
Methods List<string> - Cache
Policy stringId - Cached
Methods List<string> - Compress bool
- Default
TTL double - Field
Level stringEncryption Id - Forwarded
Values Pulumi.Aws Native. Cloud Front. Inputs. Distribution Forwarded Values - Function
Associations List<Pulumi.Aws Native. Cloud Front. Inputs. Distribution Function Association> - Lambda
Function List<Pulumi.Associations Aws Native. Cloud Front. Inputs. Distribution Lambda Function Association> - Max
TTL double - Min
TTL double - Origin
Request stringPolicy Id - Realtime
Log stringConfig Arn - Response
Headers stringPolicy Id - Smooth
Streaming bool - Trusted
Key List<string>Groups - Trusted
Signers List<string>
- Target
Origin stringId - Viewer
Protocol stringPolicy - Allowed
Methods []string - Cache
Policy stringId - Cached
Methods []string - Compress bool
- Default
TTL float64 - Field
Level stringEncryption Id - Forwarded
Values DistributionForwarded Values - Function
Associations []DistributionFunction Association - Lambda
Function []DistributionAssociations Lambda Function Association - Max
TTL float64 - Min
TTL float64 - Origin
Request stringPolicy Id - Realtime
Log stringConfig Arn - Response
Headers stringPolicy Id - Smooth
Streaming bool - Trusted
Key []stringGroups - Trusted
Signers []string
- target
Origin StringId - viewer
Protocol StringPolicy - allowed
Methods List<String> - cache
Policy StringId - cached
Methods List<String> - compress Boolean
- default
TTL Double - field
Level StringEncryption Id - forwarded
Values DistributionForwarded Values - function
Associations List<DistributionFunction Association> - lambda
Function List<DistributionAssociations Lambda Function Association> - max
TTL Double - min
TTL Double - origin
Request StringPolicy Id - realtime
Log StringConfig Arn - response
Headers StringPolicy Id - smooth
Streaming Boolean - trusted
Key List<String>Groups - trusted
Signers List<String>
- target
Origin stringId - viewer
Protocol stringPolicy - allowed
Methods string[] - cache
Policy stringId - cached
Methods string[] - compress boolean
- default
TTL number - field
Level stringEncryption Id - forwarded
Values DistributionForwarded Values - function
Associations DistributionFunction Association[] - lambda
Function DistributionAssociations Lambda Function Association[] - max
TTL number - min
TTL number - origin
Request stringPolicy Id - realtime
Log stringConfig Arn - response
Headers stringPolicy Id - smooth
Streaming boolean - trusted
Key string[]Groups - trusted
Signers string[]
- target_
origin_ strid - viewer_
protocol_ strpolicy - allowed_
methods Sequence[str] - cache_
policy_ strid - cached_
methods Sequence[str] - compress bool
- default_
ttl float - field_
level_ strencryption_ id - forwarded_
values DistributionForwarded Values - function_
associations Sequence[DistributionFunction Association] - lambda_
function_ Sequence[Distributionassociations Lambda Function Association] - max_
ttl float - min_
ttl float - origin_
request_ strpolicy_ id - realtime_
log_ strconfig_ arn - response_
headers_ strpolicy_ id - smooth_
streaming bool - trusted_
key_ Sequence[str]groups - trusted_
signers Sequence[str]
- target
Origin StringId - viewer
Protocol StringPolicy - allowed
Methods List<String> - cache
Policy StringId - cached
Methods List<String> - compress Boolean
- default
TTL Number - field
Level StringEncryption Id - forwarded
Values Property Map - function
Associations List<Property Map> - lambda
Function List<Property Map>Associations - max
TTL Number - min
TTL Number - origin
Request StringPolicy Id - realtime
Log StringConfig Arn - response
Headers StringPolicy Id - smooth
Streaming Boolean - trusted
Key List<String>Groups - trusted
Signers List<String>
DistributionForwardedValues
- Query
String bool - Pulumi.
Aws Native. Cloud Front. Inputs. Distribution Cookies - Headers List<string>
- Query
String List<string>Cache Keys
- Query
String bool - Distribution
Cookies - Headers []string
- Query
String []stringCache Keys
- query
String Boolean - Distribution
Cookies - headers List<String>
- query
String List<String>Cache Keys
- query
String boolean - Distribution
Cookies - headers string[]
- query
String string[]Cache Keys
- query_
string bool - Distribution
Cookies - headers Sequence[str]
- query_
string_ Sequence[str]cache_ keys
- query
String Boolean - Property Map
- headers List<String>
- query
String List<String>Cache Keys
DistributionFunctionAssociation
- Event
Type string - Function
ARN string
- Event
Type string - Function
ARN string
- event
Type String - function
ARN String
- event
Type string - function
ARN string
- event_
type str - function_
arn str
- event
Type String - function
ARN String
DistributionGeoRestriction
- Restriction
Type string - Locations List<string>
- Restriction
Type string - Locations []string
- restriction
Type String - locations List<String>
- restriction
Type string - locations string[]
- restriction_
type str - locations Sequence[str]
- restriction
Type String - locations List<String>
DistributionLambdaFunctionAssociation
- Event
Type string - Include
Body bool - Lambda
Function stringARN
- Event
Type string - Include
Body bool - Lambda
Function stringARN
- event
Type String - include
Body Boolean - lambda
Function StringARN
- event
Type string - include
Body boolean - lambda
Function stringARN
- event_
type str - include_
body bool - lambda_
function_ strarn
- event
Type String - include
Body Boolean - lambda
Function StringARN
DistributionLegacyCustomOrigin
- DNSName string
- Origin
Protocol stringPolicy - Origin
SSLProtocols List<string> - HTTPPort int
- HTTPSPort int
- DNSName string
- Origin
Protocol stringPolicy - Origin
SSLProtocols []string - HTTPPort int
- HTTPSPort int
- d
NSName String - origin
Protocol StringPolicy - origin
SSLProtocols List<String> - h
TTPPort Integer - h
TTPSPort Integer
- d
NSName string - origin
Protocol stringPolicy - origin
SSLProtocols string[] - h
TTPPort number - h
TTPSPort number
- d_
ns_ strname - origin_
protocol_ strpolicy - origin_
ssl_ Sequence[str]protocols - h_
ttp_ intport - h_
ttps_ intport
- d
NSName String - origin
Protocol StringPolicy - origin
SSLProtocols List<String> - h
TTPPort Number - h
TTPSPort Number
DistributionLegacyS3Origin
- DNSName string
- Origin
Access stringIdentity
- DNSName string
- Origin
Access stringIdentity
- d
NSName String - origin
Access StringIdentity
- d
NSName string - origin
Access stringIdentity
- d_
ns_ strname - origin_
access_ stridentity
- d
NSName String - origin
Access StringIdentity
DistributionLogging
DistributionOrigin
- Domain
Name string - Id string
- Connection
Attempts int - Connection
Timeout int - Custom
Origin Pulumi.Config Aws Native. Cloud Front. Inputs. Distribution Custom Origin Config - Origin
Access stringControl Id - Origin
Custom List<Pulumi.Headers Aws Native. Cloud Front. Inputs. Distribution Origin Custom Header> - Origin
Path string - Origin
Shield Pulumi.Aws Native. Cloud Front. Inputs. Distribution Origin Shield - S3Origin
Config Pulumi.Aws Native. Cloud Front. Inputs. Distribution S3Origin Config
- domain
Name String - id String
- connection
Attempts Integer - connection
Timeout Integer - custom
Origin DistributionConfig Custom Origin Config - origin
Access StringControl Id - origin
Custom List<DistributionHeaders Origin Custom Header> - origin
Path String - origin
Shield DistributionOrigin Shield - s3Origin
Config DistributionS3Origin Config
- domain_
name str - id str
- connection_
attempts int - connection_
timeout int - custom_
origin_ Distributionconfig Custom Origin Config - origin_
access_ strcontrol_ id - origin_
custom_ Sequence[Distributionheaders Origin Custom Header] - origin_
path str - origin_
shield DistributionOrigin Shield - s3_
origin_ Distributionconfig S3Origin Config
DistributionOriginCustomHeader
- Header
Name string - Header
Value string
- Header
Name string - Header
Value string
- header
Name String - header
Value String
- header
Name string - header
Value string
- header_
name str - header_
value str
- header
Name String - header
Value String
DistributionOriginGroup
DistributionOriginGroupFailoverCriteria
DistributionOriginGroupMember
- Origin
Id string
- Origin
Id string
- origin
Id String
- origin
Id string
- origin_
id str
- origin
Id String
DistributionOriginGroupMembers
- items List<Property Map>
- quantity Number
DistributionOriginGroups
- quantity Number
- items List<Property Map>
DistributionOriginShield
- Enabled bool
- Origin
Shield stringRegion
- Enabled bool
- Origin
Shield stringRegion
- enabled Boolean
- origin
Shield StringRegion
- enabled boolean
- origin
Shield stringRegion
- enabled bool
- origin_
shield_ strregion
- enabled Boolean
- origin
Shield StringRegion
DistributionRestrictions
DistributionS3OriginConfig
- Origin
Access stringIdentity
- Origin
Access stringIdentity
- origin
Access StringIdentity
- origin
Access stringIdentity
- origin
Access StringIdentity
DistributionStatusCodes
DistributionTag
DistributionViewerCertificate
- Acm
Certificate stringArn - Cloud
Front boolDefault Certificate - Iam
Certificate stringId - Minimum
Protocol stringVersion - Ssl
Support stringMethod
- Acm
Certificate stringArn - Cloud
Front boolDefault Certificate - Iam
Certificate stringId - Minimum
Protocol stringVersion - Ssl
Support stringMethod
- acm
Certificate StringArn - cloud
Front BooleanDefault Certificate - iam
Certificate StringId - minimum
Protocol StringVersion - ssl
Support StringMethod
- acm
Certificate stringArn - cloud
Front booleanDefault Certificate - iam
Certificate stringId - minimum
Protocol stringVersion - ssl
Support stringMethod
- acm
Certificate StringArn - cloud
Front BooleanDefault Certificate - iam
Certificate StringId - minimum
Protocol StringVersion - ssl
Support StringMethod
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0