interface S3LocationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.CfnGuardHook.S3LocationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#CfnGuardHook_S3LocationProperty |
![]() | software.amazon.awscdk.CfnGuardHook.S3LocationProperty |
![]() | aws_cdk.CfnGuardHook.S3LocationProperty |
![]() | aws-cdk-lib » CfnGuardHook » S3LocationProperty |
Specifies the S3 location where your Guard rules or input parameters are located.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const s3LocationProperty: cdk.CfnGuardHook.S3LocationProperty = {
uri: 'uri',
// the properties below are optional
versionId: 'versionId',
};
Properties
Name | Type | Description |
---|---|---|
uri | string | Specifies the S3 path to the file containing your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ). |
version | string | For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from. |
uri
Type:
string
Specifies the S3 path to the file containing your Guard rules or input parameters (in the form s3://<bucket name>/<file name>
).
For Guard rules, the object stored in S3 must have one of the following file extensions: .guard
, .zip
, or .tar.gz
.
For input parameters, the object stored in S3 must have one of the following file extensions: .yaml
, .json
, .zip
, or .tar.gz
.
versionId?
Type:
string
(optional)
For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.
The Guard Hook downloads files from S3 every time the Hook is invoked. To prevent accidental changes or deletions, we recommend using a version when configuring your Guard Hook.