Skip to content

Commit d238dd4

Browse files
committed
fix PFR with readme and integ updates
1 parent b314840 commit d238dd4

12 files changed

+938
-0
lines changed

packages/@aws-cdk/aws-mediapackagev2-alpha/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,25 @@ const channelGroup = ChannelGroup.fromChannelGroupAttributes(stack, 'ImportedCha
9393
});
9494
```
9595

96+
You can also import from an ARN, which automatically extracts the name and region:
97+
98+
```ts
99+
declare const stack: Stack;
100+
const channelGroup = ChannelGroup.fromChannelGroupArn(stack, 'ImportedChannelGroup',
101+
'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/MyChannelGroup',
102+
);
103+
```
104+
105+
For cross-region imports, pass the `region` parameter to ensure the correct ARN is constructed:
106+
107+
```ts
108+
declare const stack: Stack;
109+
const channelGroup = ChannelGroup.fromChannelGroupAttributes(stack, 'ImportedChannelGroup', {
110+
channelGroupName: 'MyChannelGroup',
111+
region: 'us-west-2',
112+
});
113+
```
114+
96115
## Channel
97116

98117
A channel is part of a channel group and represents the entry point for a content stream into MediaPackage.
@@ -140,6 +159,17 @@ const channel = Channel.fromChannelAttributes(stack, 'ImportedChannel', {
140159
});
141160
```
142161

162+
You can also import from an ARN:
163+
164+
```ts
165+
declare const stack: Stack;
166+
const channel = Channel.fromChannelArn(stack, 'ImportedChannel',
167+
'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/MyGroup/channel/MyChannel',
168+
);
169+
```
170+
171+
Imported channels expose a `region` property, which is parsed from the ARN or falls back to the importing stack's region.
172+
143173
### Channel Resource Policy
144174

145175
The following code creates a resource policy directly on the channel. This
@@ -184,6 +214,15 @@ const originEndpoint = OriginEndpoint.fromOriginEndpointAttributes(stack, 'Impor
184214
});
185215
```
186216

217+
You can also import from an ARN:
218+
219+
```ts
220+
declare const stack: Stack;
221+
const originEndpoint = OriginEndpoint.fromOriginEndpointArn(stack, 'ImportedOriginEndpoint',
222+
'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/MyGroup/channel/MyChannel/originEndpoint/MyEndpoint',
223+
);
224+
```
225+
187226
The following code creates a resource policy on the origin endpoint. This
188227
will automatically create a policy on the first call:
189228

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/aws-cdk-mediapackagev2-import-channel.assets.json

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/aws-cdk-mediapackagev2-import-channel.metadata.json

Lines changed: 56 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
{
2+
"Resources": {
3+
"GroupC77FDACD": {
4+
"Type": "AWS::MediaPackageV2::ChannelGroup",
5+
"Properties": {
6+
"ChannelGroupName": "import-test-group"
7+
},
8+
"UpdateReplacePolicy": "Delete",
9+
"DeletionPolicy": "Delete"
10+
},
11+
"Channel4048F119": {
12+
"Type": "AWS::MediaPackageV2::Channel",
13+
"Properties": {
14+
"ChannelGroupName": "import-test-group",
15+
"ChannelName": "import-test-channel",
16+
"InputType": "CMAF"
17+
},
18+
"DependsOn": [
19+
"GroupC77FDACD"
20+
],
21+
"UpdateReplacePolicy": "Delete",
22+
"DeletionPolicy": "Delete"
23+
},
24+
"EndpointEEF1FD8F": {
25+
"Type": "AWS::MediaPackageV2::OriginEndpoint",
26+
"Properties": {
27+
"ChannelGroupName": "import-test-group",
28+
"ChannelName": "import-test-channel",
29+
"ContainerType": "CMAF",
30+
"DashManifests": [
31+
{
32+
"ManifestName": "dash-index"
33+
}
34+
],
35+
"HlsManifests": [
36+
{
37+
"ManifestName": "hls-index"
38+
}
39+
],
40+
"OriginEndpointName": "import-test-endpoint",
41+
"Segment": {}
42+
},
43+
"DependsOn": [
44+
"Channel4048F119",
45+
"GroupC77FDACD"
46+
],
47+
"UpdateReplacePolicy": "Delete",
48+
"DeletionPolicy": "Delete"
49+
}
50+
},
51+
"Outputs": {
52+
"ImportedChannelRegion": {
53+
"Value": {
54+
"Ref": "AWS::Region"
55+
}
56+
}
57+
},
58+
"Parameters": {
59+
"BootstrapVersion": {
60+
"Type": "AWS::SSM::Parameter::Value<String>",
61+
"Default": "/cdk-bootstrap/hnb659fds/version",
62+
"Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]"
63+
}
64+
},
65+
"Rules": {
66+
"CheckBootstrapVersion": {
67+
"Assertions": [
68+
{
69+
"Assert": {
70+
"Fn::Not": [
71+
{
72+
"Fn::Contains": [
73+
[
74+
"1",
75+
"2",
76+
"3",
77+
"4",
78+
"5"
79+
],
80+
{
81+
"Ref": "BootstrapVersion"
82+
}
83+
]
84+
}
85+
]
86+
},
87+
"AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI."
88+
}
89+
]
90+
}
91+
}
92+
}

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/cdk.out

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/cdkintegmediapackagev2importchannelDefaultTestDeployAssert0BBC657E.assets.json

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/cdkintegmediapackagev2importchannelDefaultTestDeployAssert0BBC657E.metadata.json

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/cdkintegmediapackagev2importchannelDefaultTestDeployAssert0BBC657E.template.json

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/aws-mediapackagev2-alpha/test/integ.mediapackagev2-import-channel.js.snapshot/integ.json

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)