1. Packages
  2. Akamai
  3. API Docs
  4. getImagingPolicyVideo
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi

akamai.getImagingPolicyVideo

Explore with Pulumi AI

akamai logo
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi

    Using getImagingPolicyVideo

    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 getImagingPolicyVideo(args: GetImagingPolicyVideoArgs, opts?: InvokeOptions): Promise<GetImagingPolicyVideoResult>
    function getImagingPolicyVideoOutput(args: GetImagingPolicyVideoOutputArgs, opts?: InvokeOptions): Output<GetImagingPolicyVideoResult>
    def get_imaging_policy_video(policy: Optional[GetImagingPolicyVideoPolicy] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetImagingPolicyVideoResult
    def get_imaging_policy_video_output(policy: Optional[pulumi.Input[GetImagingPolicyVideoPolicyArgs]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetImagingPolicyVideoResult]
    func LookupImagingPolicyVideo(ctx *Context, args *LookupImagingPolicyVideoArgs, opts ...InvokeOption) (*LookupImagingPolicyVideoResult, error)
    func LookupImagingPolicyVideoOutput(ctx *Context, args *LookupImagingPolicyVideoOutputArgs, opts ...InvokeOption) LookupImagingPolicyVideoResultOutput

    > Note: This function is named LookupImagingPolicyVideo in the Go SDK.

    public static class GetImagingPolicyVideo 
    {
        public static Task<GetImagingPolicyVideoResult> InvokeAsync(GetImagingPolicyVideoArgs args, InvokeOptions? opts = null)
        public static Output<GetImagingPolicyVideoResult> Invoke(GetImagingPolicyVideoInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetImagingPolicyVideoResult> getImagingPolicyVideo(GetImagingPolicyVideoArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: akamai:index/getImagingPolicyVideo:getImagingPolicyVideo
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getImagingPolicyVideo Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Json string
    Policy GetImagingPolicyVideoPolicy
    Id string
    The provider-assigned unique ID for this managed resource.
    Json string
    Policy GetImagingPolicyVideoPolicy
    id String
    The provider-assigned unique ID for this managed resource.
    json String
    policy GetImagingPolicyVideoPolicy
    id string
    The provider-assigned unique ID for this managed resource.
    json string
    policy GetImagingPolicyVideoPolicy
    id str
    The provider-assigned unique ID for this managed resource.
    json str
    policy GetImagingPolicyVideoPolicy
    id String
    The provider-assigned unique ID for this managed resource.
    json String
    policy Property Map

    Supporting Types

    GetImagingPolicyVideoPolicy

    Breakpoints GetImagingPolicyVideoPolicyBreakpoints
    The breakpoint widths (in pixels) to use to create derivative images/videos.
    Hosts List<string>
    Hosts that are allowed for image/video URLs within transformations or variables.
    Output GetImagingPolicyVideoPolicyOutput
    Dictates the output quality that are created for each resized video.
    RolloutDuration string
    The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
    Variables List<GetImagingPolicyVideoPolicyVariable>
    Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
    Breakpoints GetImagingPolicyVideoPolicyBreakpoints
    The breakpoint widths (in pixels) to use to create derivative images/videos.
    Hosts []string
    Hosts that are allowed for image/video URLs within transformations or variables.
    Output GetImagingPolicyVideoPolicyOutputType
    Dictates the output quality that are created for each resized video.
    RolloutDuration string
    The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
    Variables []GetImagingPolicyVideoPolicyVariable
    Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
    breakpoints GetImagingPolicyVideoPolicyBreakpoints
    The breakpoint widths (in pixels) to use to create derivative images/videos.
    hosts List<String>
    Hosts that are allowed for image/video URLs within transformations or variables.
    output GetImagingPolicyVideoPolicyOutput
    Dictates the output quality that are created for each resized video.
    rolloutDuration String
    The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
    variables List<GetImagingPolicyVideoPolicyVariable>
    Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
    breakpoints GetImagingPolicyVideoPolicyBreakpoints
    The breakpoint widths (in pixels) to use to create derivative images/videos.
    hosts string[]
    Hosts that are allowed for image/video URLs within transformations or variables.
    output GetImagingPolicyVideoPolicyOutput
    Dictates the output quality that are created for each resized video.
    rolloutDuration string
    The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
    variables GetImagingPolicyVideoPolicyVariable[]
    Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
    breakpoints GetImagingPolicyVideoPolicyBreakpoints
    The breakpoint widths (in pixels) to use to create derivative images/videos.
    hosts Sequence[str]
    Hosts that are allowed for image/video URLs within transformations or variables.
    output GetImagingPolicyVideoPolicyOutput
    Dictates the output quality that are created for each resized video.
    rollout_duration str
    The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
    variables Sequence[GetImagingPolicyVideoPolicyVariable]
    Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
    breakpoints Property Map
    The breakpoint widths (in pixels) to use to create derivative images/videos.
    hosts List<String>
    Hosts that are allowed for image/video URLs within transformations or variables.
    output Property Map
    Dictates the output quality that are created for each resized video.
    rolloutDuration String
    The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
    variables List<Property Map>
    Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.

    GetImagingPolicyVideoPolicyBreakpoints

    Widths List<int>
    Widths []int
    widths List<Integer>
    widths number[]
    widths Sequence[int]
    widths List<Number>

    GetImagingPolicyVideoPolicyOutput

    PerceptualQuality string
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    PerceptualQualityVar string
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    PlaceholderVideoUrl string
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    PlaceholderVideoUrlVar string
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    VideoAdaptiveQuality string
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    VideoAdaptiveQualityVar string
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    PerceptualQuality string
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    PerceptualQualityVar string
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    PlaceholderVideoUrl string
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    PlaceholderVideoUrlVar string
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    VideoAdaptiveQuality string
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    VideoAdaptiveQualityVar string
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    perceptualQuality String
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    perceptualQualityVar String
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    placeholderVideoUrl String
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    placeholderVideoUrlVar String
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    videoAdaptiveQuality String
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    videoAdaptiveQualityVar String
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    perceptualQuality string
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    perceptualQualityVar string
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    placeholderVideoUrl string
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    placeholderVideoUrlVar string
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    videoAdaptiveQuality string
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    videoAdaptiveQualityVar string
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    perceptual_quality str
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    perceptual_quality_var str
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    placeholder_video_url str
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    placeholder_video_url_var str
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    video_adaptive_quality str
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    video_adaptive_quality_var str
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    perceptualQuality String
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    perceptualQualityVar String
    The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
    placeholderVideoUrl String
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    placeholderVideoUrlVar String
    Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
    videoAdaptiveQuality String
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
    videoAdaptiveQualityVar String
    Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.

    GetImagingPolicyVideoPolicyVariable

    DefaultValue string
    The default value of the variable if no query parameter is provided. It needs to be one of the enumOptions if any are provided.
    Name string
    The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
    Type string
    The type of value for the variable.
    EnumOptions List<GetImagingPolicyVideoPolicyVariableEnumOption>
    Postfix string
    A postfix added to the value provided for the variable, or to the default value.
    Prefix string
    A prefix added to the value provided for the variable, or to the default value.
    DefaultValue string
    The default value of the variable if no query parameter is provided. It needs to be one of the enumOptions if any are provided.
    Name string
    The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
    Type string
    The type of value for the variable.
    EnumOptions []GetImagingPolicyVideoPolicyVariableEnumOption
    Postfix string
    A postfix added to the value provided for the variable, or to the default value.
    Prefix string
    A prefix added to the value provided for the variable, or to the default value.
    defaultValue String
    The default value of the variable if no query parameter is provided. It needs to be one of the enumOptions if any are provided.
    name String
    The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
    type String
    The type of value for the variable.
    enumOptions List<GetImagingPolicyVideoPolicyVariableEnumOption>
    postfix String
    A postfix added to the value provided for the variable, or to the default value.
    prefix String
    A prefix added to the value provided for the variable, or to the default value.
    defaultValue string
    The default value of the variable if no query parameter is provided. It needs to be one of the enumOptions if any are provided.
    name string
    The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
    type string
    The type of value for the variable.
    enumOptions GetImagingPolicyVideoPolicyVariableEnumOption[]
    postfix string
    A postfix added to the value provided for the variable, or to the default value.
    prefix string
    A prefix added to the value provided for the variable, or to the default value.
    default_value str
    The default value of the variable if no query parameter is provided. It needs to be one of the enumOptions if any are provided.
    name str
    The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
    type str
    The type of value for the variable.
    enum_options Sequence[GetImagingPolicyVideoPolicyVariableEnumOption]
    postfix str
    A postfix added to the value provided for the variable, or to the default value.
    prefix str
    A prefix added to the value provided for the variable, or to the default value.
    defaultValue String
    The default value of the variable if no query parameter is provided. It needs to be one of the enumOptions if any are provided.
    name String
    The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
    type String
    The type of value for the variable.
    enumOptions List<Property Map>
    postfix String
    A postfix added to the value provided for the variable, or to the default value.
    prefix String
    A prefix added to the value provided for the variable, or to the default value.

    GetImagingPolicyVideoPolicyVariableEnumOption

    Id string
    The unique identifier for each enum value, up to 50 alphanumeric characters.
    Value string
    The value of the variable when the id is provided.
    Id string
    The unique identifier for each enum value, up to 50 alphanumeric characters.
    Value string
    The value of the variable when the id is provided.
    id String
    The unique identifier for each enum value, up to 50 alphanumeric characters.
    value String
    The value of the variable when the id is provided.
    id string
    The unique identifier for each enum value, up to 50 alphanumeric characters.
    value string
    The value of the variable when the id is provided.
    id str
    The unique identifier for each enum value, up to 50 alphanumeric characters.
    value str
    The value of the variable when the id is provided.
    id String
    The unique identifier for each enum value, up to 50 alphanumeric characters.
    value String
    The value of the variable when the id is provided.

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi