Class CfnGuardHook.S3LocationProperty

Specifies the S3 location where your Guard rules or input parameters are located.

Inheritance
object
CfnGuardHook.S3LocationProperty
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGuardHook.S3LocationProperty : CfnGuardHook.IS3LocationProperty
Syntax (vb)
Public Class CfnGuardHook.S3LocationProperty Implements CfnGuardHook.IS3LocationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             var s3LocationProperty = new S3LocationProperty {
                 Uri = "uri",

                 // the properties below are optional
                 VersionId = "versionId"
             };

Synopsis

Constructors

S3LocationProperty()

Specifies the S3 location where your Guard rules or input parameters are located.

Properties

Uri

Specifies the S3 path to the file containing your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ).
VersionId

For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.

Constructors

S3LocationProperty()

Specifies the S3 location where your Guard rules or input parameters are located.

public S3LocationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             var s3LocationProperty = new S3LocationProperty {
                 Uri = "uri",

                 // the properties below are optional
                 VersionId = "versionId"
             };

Properties

Uri

Specifies the S3 path to the file containing your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ).

public string Uri { get; set; }
Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-uri

VersionId

For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.

public string? VersionId { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-versionid

Implements