Interface CfnContainer.CorsRuleProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnContainer.CorsRuleProperty.Jsii$Proxy
Enclosing class:
CfnContainer

@Stability(Stable) public static interface CfnContainer.CorsRuleProperty extends software.amazon.jsii.JsiiSerializable
A rule for a CORS policy.

You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediastore.*;
 CorsRuleProperty corsRuleProperty = CorsRuleProperty.builder()
         .allowedHeaders(List.of("allowedHeaders"))
         .allowedMethods(List.of("allowedMethods"))
         .allowedOrigins(List.of("allowedOrigins"))
         .exposeHeaders(List.of("exposeHeaders"))
         .maxAgeSeconds(123)
         .build();
 
  • Method Details

    • getAllowedHeaders

      @Stability(Stable) @Nullable default List<String> getAllowedHeaders()
      Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header.

      Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

      This element can contain only one wildcard character (*).

    • getAllowedMethods

      @Stability(Stable) @Nullable default List<String> getAllowedMethods()
      Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

      Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.

    • getAllowedOrigins

      @Stability(Stable) @Nullable default List<String> getAllowedOrigins()
      One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

      Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (), for example, http://.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

    • getExposeHeaders

      @Stability(Stable) @Nullable default List<String> getExposeHeaders()
      One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

      This element is optional for each rule.

    • getMaxAgeSeconds

      @Stability(Stable) @Nullable default Number getMaxAgeSeconds()
      The time in seconds that your browser caches the preflight response for the specified resource.

      A CORS rule can have only one MaxAgeSeconds element.

    • builder

      @Stability(Stable) static CfnContainer.CorsRuleProperty.Builder builder()
      Returns:
      a CfnContainer.CorsRuleProperty.Builder of CfnContainer.CorsRuleProperty