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
AccessPointArn() *string
AccessPointCreationDate() *string
AccessPointName() *string
DomainName() *string
Env() *awscdk.ResourceEnvironment
Node() awscdk.ConstructNode
PhysicalName() *string
RegionalDomainName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
Prepare()
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
VirtualHostedUrlForObject(key *string, options *awss3.VirtualHostedStyleUrlOptions) *string
}
An S3 object lambda access point for intercepting and transforming `GetObject` requests.
TODO: EXAMPLE
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 `json:"accessPointArn" yaml:"accessPointArn"`
// The creation data of the access point.
// Experimental.
AccessPointCreationDate *string `json:"accessPointCreationDate" yaml:"accessPointCreationDate"`
}
The access point resource attributes.
TODO: EXAMPLE
Experimental.
type AccessPointProps ¶
type AccessPointProps struct {
// The bucket to which this access point belongs.
// Experimental.
Bucket awss3.IBucket `json:"bucket" yaml:"bucket"`
// The Lambda function used to transform objects.
// Experimental.
Handler awslambda.IFunction `json:"handler" yaml:"handler"`
// The name of the S3 object lambda access point.
// Experimental.
AccessPointName *string `json:"accessPointName" yaml:"accessPointName"`
// Whether CloudWatch metrics are enabled for the access point.
// Experimental.
CloudWatchMetricsEnabled *bool `json:"cloudWatchMetricsEnabled" yaml:"cloudWatchMetricsEnabled"`
// Additional JSON that provides supplemental data passed to the Lambda function on every request.
// Experimental.
Payload *map[string]interface{} `json:"payload" yaml:"payload"`
// Whether the Lambda function can process `GetObject-PartNumber` requests.
// Experimental.
SupportsGetObjectPartNumber *bool `json:"supportsGetObjectPartNumber" yaml:"supportsGetObjectPartNumber"`
// Whether the Lambda function can process `GetObject-Range` requests.
// Experimental.
SupportsGetObjectRange *bool `json:"supportsGetObjectRange" yaml:"supportsGetObjectRange"`
}
The S3 object lambda access point configuration.
TODO: EXAMPLE
Experimental.
type CfnAccessPoint ¶
type CfnAccessPoint interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrCreationDate() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
ObjectLambdaConfiguration() interface{}
SetObjectLambdaConfiguration(val interface{})
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::S3ObjectLambda::AccessPoint`.
The `AWS::S3ObjectLambda::AccessPoint` resource specifies an Object Lambda Access Point used to access a bucket.
TODO: EXAMPLE
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
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Node() awscdk.ConstructNode
ObjectLambdaAccessPoint() *string
SetObjectLambdaAccessPoint(val *string)
PolicyDocument() interface{}
SetPolicyDocument(val interface{})
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::S3ObjectLambda::AccessPointPolicy`.
The `AWS::S3ObjectLambda::AccessPointPolicy` resource specifies the Object Lambda Access Point resource policy document.
TODO: EXAMPLE
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 `json:"objectLambdaAccessPoint" yaml:"objectLambdaAccessPoint"`
// Object Lambda Access Point resource policy document.
PolicyDocument interface{} `json:"policyDocument" yaml:"policyDocument"`
}
Properties for defining a `CfnAccessPointPolicy`.
TODO: EXAMPLE
type CfnAccessPointProps ¶
type CfnAccessPointProps struct {
// A configuration used when creating an Object Lambda Access Point.
ObjectLambdaConfiguration interface{} `json:"objectLambdaConfiguration" yaml:"objectLambdaConfiguration"`
// The name of this access point.
Name *string `json:"name" yaml:"name"`
}
Properties for defining a `CfnAccessPoint`.
TODO: EXAMPLE
type CfnAccessPoint_ObjectLambdaConfigurationProperty ¶
type CfnAccessPoint_ObjectLambdaConfigurationProperty struct {
// Standard access point associated with the Object Lambda Access Point.
SupportingAccessPoint *string `json:"supportingAccessPoint" yaml:"supportingAccessPoint"`
// A container for transformation configurations for an Object Lambda Access Point.
TransformationConfigurations interface{} `json:"transformationConfigurations" yaml:"transformationConfigurations"`
// A container for allowed features.
//
// Valid inputs are `GetObject-Range` and `GetObject-PartNumber` .
AllowedFeatures *[]*string `json:"allowedFeatures" yaml:"allowedFeatures"`
// A container for whether the CloudWatch metrics configuration is enabled.
CloudWatchMetricsEnabled interface{} `json:"cloudWatchMetricsEnabled" yaml:"cloudWatchMetricsEnabled"`
}
A configuration used when creating an Object Lambda Access Point.
TODO: EXAMPLE
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 `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{} `json:"contentTransformation" yaml:"contentTransformation"`
}
A configuration used when creating an Object Lambda Access Point transformation.
TODO: EXAMPLE
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.