Documentation
¶
Index ¶
- func AccessPoint_IsConstruct(x interface{}) *bool
- func AccessPoint_IsResource(construct awscdk.IConstruct) *bool
- func CfnAccessPointPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAccessPointPolicy_IsCfnElement(x interface{}) *bool
- func CfnAccessPointPolicy_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAccessPointPolicy_IsConstruct(x interface{}) *bool
- func CfnAccessPoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAccessPoint_IsCfnElement(x interface{}) *bool
- func CfnAccessPoint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAccessPoint_IsConstruct(x interface{}) *bool
- func NewAccessPoint_Override(a AccessPoint, scope constructs.Construct, id *string, props *AccessPointProps)
- func NewCfnAccessPointPolicy_Override(c CfnAccessPointPolicy, scope awscdk.Construct, id *string, ...)
- func NewCfnAccessPoint_Override(c CfnAccessPoint, scope awscdk.Construct, id *string, ...)
- type AccessPoint
- type AccessPointAttributes
- type AccessPointProps
- type CfnAccessPoint
- type CfnAccessPointPolicy
- type CfnAccessPointPolicyProps
- type CfnAccessPointProps
- type CfnAccessPoint_ObjectLambdaConfigurationProperty
- type CfnAccessPoint_TransformationConfigurationProperty
- type IAccessPoint
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AccessPoint_IsConstruct ¶
func AccessPoint_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func AccessPoint_IsResource ¶
func AccessPoint_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func CfnAccessPointPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnAccessPointPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnAccessPointPolicy_IsCfnElement ¶
func CfnAccessPointPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnAccessPointPolicy_IsCfnResource ¶
func CfnAccessPointPolicy_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAccessPointPolicy_IsConstruct ¶
func CfnAccessPointPolicy_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnAccessPoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnAccessPoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnAccessPoint_IsCfnElement ¶
func CfnAccessPoint_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnAccessPoint_IsCfnResource ¶
func CfnAccessPoint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAccessPoint_IsConstruct ¶
func CfnAccessPoint_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewAccessPoint_Override ¶
func NewAccessPoint_Override(a AccessPoint, scope constructs.Construct, id *string, props *AccessPointProps)
Experimental.
func NewCfnAccessPointPolicy_Override ¶
func NewCfnAccessPointPolicy_Override(c CfnAccessPointPolicy, scope awscdk.Construct, id *string, props *CfnAccessPointPolicyProps)
Create a new `AWS::S3ObjectLambda::AccessPointPolicy`.
func NewCfnAccessPoint_Override ¶
func NewCfnAccessPoint_Override(c CfnAccessPoint, scope awscdk.Construct, id *string, props *CfnAccessPointProps)
Create a new `AWS::S3ObjectLambda::AccessPoint`.
Types ¶
type AccessPoint ¶
type AccessPoint interface {
awscdk.Resource
IAccessPoint
// The ARN of the access point.
// Experimental.
AccessPointArn() *string
// The creation data of the access point.
// Experimental.
AccessPointCreationDate() *string
// The ARN of the access point.
// Experimental.
AccessPointName() *string
// Implement the {@link IAccessPoint.domainName} field.
// Experimental.
DomainName() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
// Experimental.
Env() *awscdk.ResourceEnvironment
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
// Experimental.
PhysicalName() *string
// Implement the {@link IAccessPoint.regionalDomainName} field.
// Experimental.
RegionalDomainName() *string
// The stack in which this resource is defined.
// Experimental.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Experimental.
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
// Experimental.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
// Experimental.
GetResourceNameAttribute(nameAttr *string) *string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Implement the {@link IAccessPoint.virtualHostedUrlForObject} method.
// Experimental.
VirtualHostedUrlForObject(key *string, options *awss3.VirtualHostedStyleUrlOptions) *string
}
An S3 object lambda access point for intercepting and transforming `GetObject` requests.
Example:
// Example automatically generated from non-compiling source. May contain errors.
import lambda "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
import s3objectlambda "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
stack := cdk.NewStack()
bucket := s3.NewBucket(stack, jsii.String("MyBucket"))
handler := lambda.NewFunction(stack, jsii.String("MyFunction"), &functionProps{
runtime: lambda.runtime_NODEJS_14_X(),
handler: jsii.String("index.handler"),
code: lambda.code.fromAsset(jsii.String("lambda.zip")),
})
s3objectlambda.NewAccessPoint(stack, jsii.String("MyObjectLambda"), &accessPointProps{
bucket: bucket,
handler: handler,
accessPointName: jsii.String("my-access-point"),
payload: map[string]interface{}{
"prop": jsii.String("value"),
},
})
Experimental.
func NewAccessPoint ¶
func NewAccessPoint(scope constructs.Construct, id *string, props *AccessPointProps) AccessPoint
Experimental.
type AccessPointAttributes ¶
type AccessPointAttributes struct {
// The ARN of the access point.
// Experimental.
AccessPointArn *string `field:"required" json:"accessPointArn" yaml:"accessPointArn"`
// The creation data of the access point.
// Experimental.
AccessPointCreationDate *string `field:"required" json:"accessPointCreationDate" yaml:"accessPointCreationDate"`
}
The access point resource attributes.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
accessPointAttributes := &accessPointAttributes{
accessPointArn: jsii.String("accessPointArn"),
accessPointCreationDate: jsii.String("accessPointCreationDate"),
}
Experimental.
type AccessPointProps ¶
type AccessPointProps struct {
// The bucket to which this access point belongs.
// Experimental.
Bucket awss3.IBucket `field:"required" json:"bucket" yaml:"bucket"`
// The Lambda function used to transform objects.
// Experimental.
Handler awslambda.IFunction `field:"required" json:"handler" yaml:"handler"`
// The name of the S3 object lambda access point.
// Experimental.
AccessPointName *string `field:"optional" json:"accessPointName" yaml:"accessPointName"`
// Whether CloudWatch metrics are enabled for the access point.
// Experimental.
CloudWatchMetricsEnabled *bool `field:"optional" json:"cloudWatchMetricsEnabled" yaml:"cloudWatchMetricsEnabled"`
// Additional JSON that provides supplemental data passed to the Lambda function on every request.
// Experimental.
Payload *map[string]interface{} `field:"optional" json:"payload" yaml:"payload"`
// Whether the Lambda function can process `GetObject-PartNumber` requests.
// Experimental.
SupportsGetObjectPartNumber *bool `field:"optional" json:"supportsGetObjectPartNumber" yaml:"supportsGetObjectPartNumber"`
// Whether the Lambda function can process `GetObject-Range` requests.
// Experimental.
SupportsGetObjectRange *bool `field:"optional" json:"supportsGetObjectRange" yaml:"supportsGetObjectRange"`
}
The S3 object lambda access point configuration.
Example:
// Example automatically generated from non-compiling source. May contain errors.
import lambda "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
import s3objectlambda "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
stack := cdk.NewStack()
bucket := s3.NewBucket(stack, jsii.String("MyBucket"))
handler := lambda.NewFunction(stack, jsii.String("MyFunction"), &functionProps{
runtime: lambda.runtime_NODEJS_14_X(),
handler: jsii.String("index.handler"),
code: lambda.code.fromAsset(jsii.String("lambda.zip")),
})
s3objectlambda.NewAccessPoint(stack, jsii.String("MyObjectLambda"), &accessPointProps{
bucket: bucket,
handler: handler,
accessPointName: jsii.String("my-access-point"),
payload: map[string]interface{}{
"prop": jsii.String("value"),
},
})
Experimental.
type CfnAccessPoint ¶
type CfnAccessPoint interface {
awscdk.CfnResource
awscdk.IInspectable
// Specifies the ARN for the Object Lambda Access Point.
AttrArn() *string
// The date and time when the specified Object Lambda Access Point was created.
AttrCreationDate() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of this access point.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// A configuration used when creating an Object Lambda Access Point.
ObjectLambdaConfiguration() interface{}
SetObjectLambdaConfiguration(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::S3ObjectLambda::AccessPoint`.
The `AWS::S3ObjectLambda::AccessPoint` resource specifies an Object Lambda Access Point used to access a bucket.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var contentTransformation interface{}
cfnAccessPoint := awscdk.Aws_s3objectlambda.NewCfnAccessPoint(this, jsii.String("MyCfnAccessPoint"), &cfnAccessPointProps{
objectLambdaConfiguration: &objectLambdaConfigurationProperty{
supportingAccessPoint: jsii.String("supportingAccessPoint"),
transformationConfigurations: []interface{}{
&transformationConfigurationProperty{
actions: []*string{
jsii.String("actions"),
},
contentTransformation: contentTransformation,
},
},
// the properties below are optional
allowedFeatures: []*string{
jsii.String("allowedFeatures"),
},
cloudWatchMetricsEnabled: jsii.Boolean(false),
},
// the properties below are optional
name: jsii.String("name"),
})
func NewCfnAccessPoint ¶
func NewCfnAccessPoint(scope awscdk.Construct, id *string, props *CfnAccessPointProps) CfnAccessPoint
Create a new `AWS::S3ObjectLambda::AccessPoint`.
type CfnAccessPointPolicy ¶
type CfnAccessPointPolicy interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// An access point with an attached AWS Lambda function used to access transformed data from an Amazon S3 bucket.
ObjectLambdaAccessPoint() *string
SetObjectLambdaAccessPoint(val *string)
// Object Lambda Access Point resource policy document.
PolicyDocument() interface{}
SetPolicyDocument(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::S3ObjectLambda::AccessPointPolicy`.
The `AWS::S3ObjectLambda::AccessPointPolicy` resource specifies the Object Lambda Access Point resource policy document.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var policyDocument interface{}
cfnAccessPointPolicy := awscdk.Aws_s3objectlambda.NewCfnAccessPointPolicy(this, jsii.String("MyCfnAccessPointPolicy"), &cfnAccessPointPolicyProps{
objectLambdaAccessPoint: jsii.String("objectLambdaAccessPoint"),
policyDocument: policyDocument,
})
func NewCfnAccessPointPolicy ¶
func NewCfnAccessPointPolicy(scope awscdk.Construct, id *string, props *CfnAccessPointPolicyProps) CfnAccessPointPolicy
Create a new `AWS::S3ObjectLambda::AccessPointPolicy`.
type CfnAccessPointPolicyProps ¶
type CfnAccessPointPolicyProps struct {
// An access point with an attached AWS Lambda function used to access transformed data from an Amazon S3 bucket.
ObjectLambdaAccessPoint *string `field:"required" json:"objectLambdaAccessPoint" yaml:"objectLambdaAccessPoint"`
// Object Lambda Access Point resource policy document.
PolicyDocument interface{} `field:"required" json:"policyDocument" yaml:"policyDocument"`
}
Properties for defining a `CfnAccessPointPolicy`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var policyDocument interface{}
cfnAccessPointPolicyProps := &cfnAccessPointPolicyProps{
objectLambdaAccessPoint: jsii.String("objectLambdaAccessPoint"),
policyDocument: policyDocument,
}
type CfnAccessPointProps ¶
type CfnAccessPointProps struct {
// A configuration used when creating an Object Lambda Access Point.
ObjectLambdaConfiguration interface{} `field:"required" json:"objectLambdaConfiguration" yaml:"objectLambdaConfiguration"`
// The name of this access point.
Name *string `field:"optional" json:"name" yaml:"name"`
}
Properties for defining a `CfnAccessPoint`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var contentTransformation interface{}
cfnAccessPointProps := &cfnAccessPointProps{
objectLambdaConfiguration: &objectLambdaConfigurationProperty{
supportingAccessPoint: jsii.String("supportingAccessPoint"),
transformationConfigurations: []interface{}{
&transformationConfigurationProperty{
actions: []*string{
jsii.String("actions"),
},
contentTransformation: contentTransformation,
},
},
// the properties below are optional
allowedFeatures: []*string{
jsii.String("allowedFeatures"),
},
cloudWatchMetricsEnabled: jsii.Boolean(false),
},
// the properties below are optional
name: jsii.String("name"),
}
type CfnAccessPoint_ObjectLambdaConfigurationProperty ¶
type CfnAccessPoint_ObjectLambdaConfigurationProperty struct {
// Standard access point associated with the Object Lambda Access Point.
SupportingAccessPoint *string `field:"required" json:"supportingAccessPoint" yaml:"supportingAccessPoint"`
// A container for transformation configurations for an Object Lambda Access Point.
TransformationConfigurations interface{} `field:"required" json:"transformationConfigurations" yaml:"transformationConfigurations"`
// A container for allowed features.
//
// Valid inputs are `GetObject-Range` and `GetObject-PartNumber` .
AllowedFeatures *[]*string `field:"optional" json:"allowedFeatures" yaml:"allowedFeatures"`
// A container for whether the CloudWatch metrics configuration is enabled.
CloudWatchMetricsEnabled interface{} `field:"optional" json:"cloudWatchMetricsEnabled" yaml:"cloudWatchMetricsEnabled"`
}
A configuration used when creating an Object Lambda Access Point.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var contentTransformation interface{}
objectLambdaConfigurationProperty := &objectLambdaConfigurationProperty{
supportingAccessPoint: jsii.String("supportingAccessPoint"),
transformationConfigurations: []interface{}{
&transformationConfigurationProperty{
actions: []*string{
jsii.String("actions"),
},
contentTransformation: contentTransformation,
},
},
// the properties below are optional
allowedFeatures: []*string{
jsii.String("allowedFeatures"),
},
cloudWatchMetricsEnabled: jsii.Boolean(false),
}
type CfnAccessPoint_TransformationConfigurationProperty ¶
type CfnAccessPoint_TransformationConfigurationProperty struct {
// A container for the action of an Object Lambda Access Point configuration.
//
// Valid input is `GetObject` .
Actions *[]*string `field:"required" json:"actions" yaml:"actions"`
// A container for the content transformation of an Object Lambda Access Point configuration.
//
// Can include the FunctionArn and FunctionPayload. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference* .
ContentTransformation interface{} `field:"required" json:"contentTransformation" yaml:"contentTransformation"`
}
A configuration used when creating an Object Lambda Access Point transformation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var contentTransformation interface{}
transformationConfigurationProperty := &transformationConfigurationProperty{
actions: []*string{
jsii.String("actions"),
},
contentTransformation: contentTransformation,
}
type IAccessPoint ¶
type IAccessPoint interface {
awscdk.IResource
// The virtual hosted-style URL of an S3 object through this access point.
//
// Specify `regional: false` at the options for non-regional URL.
//
// Returns: an ObjectS3Url token.
// Experimental.
VirtualHostedUrlForObject(key *string, options *awss3.VirtualHostedStyleUrlOptions) *string
// The ARN of the access point.
// Experimental.
AccessPointArn() *string
// The creation data of the access point.
// Experimental.
AccessPointCreationDate() *string
// The IPv4 DNS name of the access point.
// Experimental.
DomainName() *string
// The regional domain name of the access point.
// Experimental.
RegionalDomainName() *string
}
The interface that represents the AccessPoint resource. Experimental.
func AccessPoint_FromAccessPointAttributes ¶
func AccessPoint_FromAccessPointAttributes(scope constructs.Construct, id *string, attrs *AccessPointAttributes) IAccessPoint
Reference an existing AccessPoint defined outside of the CDK code. Experimental.