

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::MediaPackageV2::OriginEndpointPolicy
<a name="aws-resource-mediapackagev2-originendpointpolicy"></a>

Specifies the configuration parameters of a policy associated with a MediaPackage V2 origin endpoint.

## Syntax
<a name="aws-resource-mediapackagev2-originendpointpolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-mediapackagev2-originendpointpolicy-syntax.json"></a>

```
{
  "Type" : "AWS::MediaPackageV2::OriginEndpointPolicy",
  "Properties" : {
      "[CdnAuthConfiguration](#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration)" : CdnAuthConfiguration,
      "[ChannelGroupName](#cfn-mediapackagev2-originendpointpolicy-channelgroupname)" : String,
      "[ChannelName](#cfn-mediapackagev2-originendpointpolicy-channelname)" : String,
      "[OriginEndpointName](#cfn-mediapackagev2-originendpointpolicy-originendpointname)" : String,
      "[Policy](#cfn-mediapackagev2-originendpointpolicy-policy)" : Json
    }
}
```

### YAML
<a name="aws-resource-mediapackagev2-originendpointpolicy-syntax.yaml"></a>

```
Type: AWS::MediaPackageV2::OriginEndpointPolicy
Properties:
  [CdnAuthConfiguration](#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration): 
    CdnAuthConfiguration
  [ChannelGroupName](#cfn-mediapackagev2-originendpointpolicy-channelgroupname): String
  [ChannelName](#cfn-mediapackagev2-originendpointpolicy-channelname): String
  [OriginEndpointName](#cfn-mediapackagev2-originendpointpolicy-originendpointname): String
  [Policy](#cfn-mediapackagev2-originendpointpolicy-policy): Json
```

## Properties
<a name="aws-resource-mediapackagev2-originendpointpolicy-properties"></a>

`CdnAuthConfiguration`  <a name="cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration"></a>
The settings to enable CDN authorization headers in MediaPackage.  
*Required*: No  
*Type*: [CdnAuthConfiguration](aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ChannelGroupName`  <a name="cfn-mediapackagev2-originendpointpolicy-channelgroupname"></a>
The name of the channel group associated with the origin endpoint policy.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ChannelName`  <a name="cfn-mediapackagev2-originendpointpolicy-channelname"></a>
The channel name associated with the origin endpoint policy.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OriginEndpointName`  <a name="cfn-mediapackagev2-originendpointpolicy-originendpointname"></a>
The name of the origin endpoint associated with the origin endpoint policy.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Policy`  <a name="cfn-mediapackagev2-originendpointpolicy-policy"></a>
The policy associated with the origin endpoint.  
*Required*: Yes  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-mediapackagev2-originendpointpolicy-return-values"></a>

### Ref
<a name="aws-resource-mediapackagev2-originendpointpolicy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ChannelGroupName/ChannelName/OriginEndpointName`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

# AWS::MediaPackageV2::OriginEndpointPolicy CdnAuthConfiguration
<a name="aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration"></a>

The settings to enable CDN authorization headers in MediaPackage.

## Syntax
<a name="aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration-syntax.json"></a>

```
{
  "[CdnIdentifierSecretArns](#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-cdnidentifiersecretarns)" : [ String, ... ],
  "[SecretsRoleArn](#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-secretsrolearn)" : String
}
```

### YAML
<a name="aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration-syntax.yaml"></a>

```
  [CdnIdentifierSecretArns](#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-cdnidentifiersecretarns): 
    - String
  [SecretsRoleArn](#cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-secretsrolearn): String
```

## Properties
<a name="aws-properties-mediapackagev2-originendpointpolicy-cdnauthconfiguration-properties"></a>

`CdnIdentifierSecretArns`  <a name="cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-cdnidentifiersecretarns"></a>
The ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `20 | 1`  
*Maximum*: `2048 | 100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsRoleArn`  <a name="cfn-mediapackagev2-originendpointpolicy-cdnauthconfiguration-secretsrolearn"></a>
The ARN for the IAM role that gives MediaPackage read access to Secrets Manager and AWS KMS for CDN authorization.  
*Required*: Yes  
*Type*: String  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)