s3express

package
v0.101.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DirectoryBucketDataRedundancySingleAvailabilityZone = DirectoryBucketDataRedundancy("SingleAvailabilityZone")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BucketPolicy 

type BucketPolicy struct {
	pulumi.CustomResourceState

	// The name of the S3 directory bucket to which the policy applies.
	Bucket pulumi.StringOutput `pulumi:"bucket"`
	// A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::S3Express::BucketPolicy` for more information about the expected schema for this property.
	PolicyDocument pulumi.AnyOutput `pulumi:"policyDocument"`
}

Resource Type definition for AWS::S3Express::BucketPolicy.

func GetBucketPolicy 

func GetBucketPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BucketPolicyState, opts ...pulumi.ResourceOption) (*BucketPolicy, error)

GetBucketPolicy gets an existing BucketPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBucketPolicy 

func NewBucketPolicy(ctx *pulumi.Context,
	name string, args *BucketPolicyArgs, opts ...pulumi.ResourceOption) (*BucketPolicy, error)

NewBucketPolicy registers a new resource with the given unique name, arguments, and options.

func (*BucketPolicy) ElementType 

func (*BucketPolicy) ElementType() reflect.Type

func (*BucketPolicy) ToBucketPolicyOutput 

func (i *BucketPolicy) ToBucketPolicyOutput() BucketPolicyOutput

func (*BucketPolicy) ToBucketPolicyOutputWithContext 

func (i *BucketPolicy) ToBucketPolicyOutputWithContext(ctx context.Context) BucketPolicyOutput

type BucketPolicyArgs 

type BucketPolicyArgs struct {
	// The name of the S3 directory bucket to which the policy applies.
	Bucket pulumi.StringInput
	// A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::S3Express::BucketPolicy` for more information about the expected schema for this property.
	PolicyDocument pulumi.Input
}

The set of arguments for constructing a BucketPolicy resource.

func (BucketPolicyArgs) ElementType 

func (BucketPolicyArgs) ElementType() reflect.Type

type BucketPolicyInput 

type BucketPolicyInput interface {
	pulumi.Input

	ToBucketPolicyOutput() BucketPolicyOutput
	ToBucketPolicyOutputWithContext(ctx context.Context) BucketPolicyOutput
}

type BucketPolicyOutput 

type BucketPolicyOutput struct{ *pulumi.OutputState }

func (BucketPolicyOutput) Bucket 

func (o BucketPolicyOutput) Bucket() pulumi.StringOutput

The name of the S3 directory bucket to which the policy applies.

func (BucketPolicyOutput) ElementType 

func (BucketPolicyOutput) ElementType() reflect.Type

func (BucketPolicyOutput) PolicyDocument 

func (o BucketPolicyOutput) PolicyDocument() pulumi.AnyOutput

A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::S3Express::BucketPolicy` for more information about the expected schema for this property.

func (BucketPolicyOutput) ToBucketPolicyOutput 

func (o BucketPolicyOutput) ToBucketPolicyOutput() BucketPolicyOutput

func (BucketPolicyOutput) ToBucketPolicyOutputWithContext 

func (o BucketPolicyOutput) ToBucketPolicyOutputWithContext(ctx context.Context) BucketPolicyOutput

type BucketPolicyState 

type BucketPolicyState struct {
}

func (BucketPolicyState) ElementType 

func (BucketPolicyState) ElementType() reflect.Type

type DirectoryBucket 

type DirectoryBucket struct {
	pulumi.CustomResourceState

	// Returns the Amazon Resource Name (ARN) of the specified bucket.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
	BucketName pulumi.StringPtrOutput `pulumi:"bucketName"`
	// Specifies the number of Availability Zone that's used for redundancy for the bucket.
	DataRedundancy DirectoryBucketDataRedundancyOutput `pulumi:"dataRedundancy"`
	// Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
	LocationName pulumi.StringOutput `pulumi:"locationName"`
}

Resource Type definition for AWS::S3Express::DirectoryBucket.

func GetDirectoryBucket 

func GetDirectoryBucket(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DirectoryBucketState, opts ...pulumi.ResourceOption) (*DirectoryBucket, error)

GetDirectoryBucket gets an existing DirectoryBucket resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDirectoryBucket 

func NewDirectoryBucket(ctx *pulumi.Context,
	name string, args *DirectoryBucketArgs, opts ...pulumi.ResourceOption) (*DirectoryBucket, error)

NewDirectoryBucket registers a new resource with the given unique name, arguments, and options.

func (*DirectoryBucket) ElementType 

func (*DirectoryBucket) ElementType() reflect.Type

func (*DirectoryBucket) ToDirectoryBucketOutput 

func (i *DirectoryBucket) ToDirectoryBucketOutput() DirectoryBucketOutput

func (*DirectoryBucket) ToDirectoryBucketOutputWithContext 

func (i *DirectoryBucket) ToDirectoryBucketOutputWithContext(ctx context.Context) DirectoryBucketOutput

type DirectoryBucketArgs 

type DirectoryBucketArgs struct {
	// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
	BucketName pulumi.StringPtrInput
	// Specifies the number of Availability Zone that's used for redundancy for the bucket.
	DataRedundancy DirectoryBucketDataRedundancyInput
	// Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
	LocationName pulumi.StringInput
}

The set of arguments for constructing a DirectoryBucket resource.

func (DirectoryBucketArgs) ElementType 

func (DirectoryBucketArgs) ElementType() reflect.Type

type DirectoryBucketDataRedundancy 

type DirectoryBucketDataRedundancy string

Specifies the number of Availability Zone that's used for redundancy for the bucket.

func (DirectoryBucketDataRedundancy) ElementType 

func (DirectoryBucketDataRedundancy) ElementType() reflect.Type

func (DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyOutput 

func (e DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyOutput() DirectoryBucketDataRedundancyOutput

func (DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyOutputWithContext 

func (e DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyOutputWithContext(ctx context.Context) DirectoryBucketDataRedundancyOutput

func (DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyPtrOutput 

func (e DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyPtrOutput() DirectoryBucketDataRedundancyPtrOutput

func (DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyPtrOutputWithContext 

func (e DirectoryBucketDataRedundancy) ToDirectoryBucketDataRedundancyPtrOutputWithContext(ctx context.Context) DirectoryBucketDataRedundancyPtrOutput

func (DirectoryBucketDataRedundancy) ToStringOutput 

func (e DirectoryBucketDataRedundancy) ToStringOutput() pulumi.StringOutput

func (DirectoryBucketDataRedundancy) ToStringOutputWithContext 

func (e DirectoryBucketDataRedundancy) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DirectoryBucketDataRedundancy) ToStringPtrOutput 

func (e DirectoryBucketDataRedundancy) ToStringPtrOutput() pulumi.StringPtrOutput

func (DirectoryBucketDataRedundancy) ToStringPtrOutputWithContext 

func (e DirectoryBucketDataRedundancy) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DirectoryBucketDataRedundancyInput 

type DirectoryBucketDataRedundancyInput interface {
	pulumi.Input

	ToDirectoryBucketDataRedundancyOutput() DirectoryBucketDataRedundancyOutput
	ToDirectoryBucketDataRedundancyOutputWithContext(context.Context) DirectoryBucketDataRedundancyOutput
}

DirectoryBucketDataRedundancyInput is an input type that accepts values of the DirectoryBucketDataRedundancy enum A concrete instance of `DirectoryBucketDataRedundancyInput` can be one of the following: 

DirectoryBucketDataRedundancySingleAvailabilityZone

type DirectoryBucketDataRedundancyOutput 

type DirectoryBucketDataRedundancyOutput struct{ *pulumi.OutputState }

func (DirectoryBucketDataRedundancyOutput) ElementType 

func (DirectoryBucketDataRedundancyOutput) ElementType() reflect.Type

func (DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyOutput 

func (o DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyOutput() DirectoryBucketDataRedundancyOutput

func (DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyOutputWithContext 

func (o DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyOutputWithContext(ctx context.Context) DirectoryBucketDataRedundancyOutput

func (DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyPtrOutput 

func (o DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyPtrOutput() DirectoryBucketDataRedundancyPtrOutput

func (DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyPtrOutputWithContext 

func (o DirectoryBucketDataRedundancyOutput) ToDirectoryBucketDataRedundancyPtrOutputWithContext(ctx context.Context) DirectoryBucketDataRedundancyPtrOutput

func (DirectoryBucketDataRedundancyOutput) ToStringOutput 

func (o DirectoryBucketDataRedundancyOutput) ToStringOutput() pulumi.StringOutput

func (DirectoryBucketDataRedundancyOutput) ToStringOutputWithContext 

func (o DirectoryBucketDataRedundancyOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DirectoryBucketDataRedundancyOutput) ToStringPtrOutput 

func (o DirectoryBucketDataRedundancyOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DirectoryBucketDataRedundancyOutput) ToStringPtrOutputWithContext 

func (o DirectoryBucketDataRedundancyOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DirectoryBucketDataRedundancyPtrInput 

type DirectoryBucketDataRedundancyPtrInput interface {
	pulumi.Input

	ToDirectoryBucketDataRedundancyPtrOutput() DirectoryBucketDataRedundancyPtrOutput
	ToDirectoryBucketDataRedundancyPtrOutputWithContext(context.Context) DirectoryBucketDataRedundancyPtrOutput
}

func DirectoryBucketDataRedundancyPtr 

func DirectoryBucketDataRedundancyPtr(v string) DirectoryBucketDataRedundancyPtrInput

type DirectoryBucketDataRedundancyPtrOutput 

type DirectoryBucketDataRedundancyPtrOutput struct{ *pulumi.OutputState }

func (DirectoryBucketDataRedundancyPtrOutput) Elem 

func (o DirectoryBucketDataRedundancyPtrOutput) Elem() DirectoryBucketDataRedundancyOutput

func (DirectoryBucketDataRedundancyPtrOutput) ElementType 

func (DirectoryBucketDataRedundancyPtrOutput) ElementType() reflect.Type

func (DirectoryBucketDataRedundancyPtrOutput) ToDirectoryBucketDataRedundancyPtrOutput 

func (o DirectoryBucketDataRedundancyPtrOutput) ToDirectoryBucketDataRedundancyPtrOutput() DirectoryBucketDataRedundancyPtrOutput

func (DirectoryBucketDataRedundancyPtrOutput) ToDirectoryBucketDataRedundancyPtrOutputWithContext 

func (o DirectoryBucketDataRedundancyPtrOutput) ToDirectoryBucketDataRedundancyPtrOutputWithContext(ctx context.Context) DirectoryBucketDataRedundancyPtrOutput

func (DirectoryBucketDataRedundancyPtrOutput) ToStringPtrOutput 

func (o DirectoryBucketDataRedundancyPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DirectoryBucketDataRedundancyPtrOutput) ToStringPtrOutputWithContext 

func (o DirectoryBucketDataRedundancyPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DirectoryBucketInput 

type DirectoryBucketInput interface {
	pulumi.Input

	ToDirectoryBucketOutput() DirectoryBucketOutput
	ToDirectoryBucketOutputWithContext(ctx context.Context) DirectoryBucketOutput
}

type DirectoryBucketOutput 

type DirectoryBucketOutput struct{ *pulumi.OutputState }

func (DirectoryBucketOutput) Arn 

func (o DirectoryBucketOutput) Arn() pulumi.StringOutput

Returns the Amazon Resource Name (ARN) of the specified bucket.

func (DirectoryBucketOutput) BucketName 

func (o DirectoryBucketOutput) BucketName() pulumi.StringPtrOutput

Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.

func (DirectoryBucketOutput) DataRedundancy 

func (o DirectoryBucketOutput) DataRedundancy() DirectoryBucketDataRedundancyOutput

Specifies the number of Availability Zone that's used for redundancy for the bucket.

func (DirectoryBucketOutput) ElementType 

func (DirectoryBucketOutput) ElementType() reflect.Type

func (DirectoryBucketOutput) LocationName 

func (o DirectoryBucketOutput) LocationName() pulumi.StringOutput

Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.

func (DirectoryBucketOutput) ToDirectoryBucketOutput 

func (o DirectoryBucketOutput) ToDirectoryBucketOutput() DirectoryBucketOutput

func (DirectoryBucketOutput) ToDirectoryBucketOutputWithContext 

func (o DirectoryBucketOutput) ToDirectoryBucketOutputWithContext(ctx context.Context) DirectoryBucketOutput

type DirectoryBucketState 

type DirectoryBucketState struct {
}

func (DirectoryBucketState) ElementType 

func (DirectoryBucketState) ElementType() reflect.Type

type LookupBucketPolicyArgs 

type LookupBucketPolicyArgs struct {
	// The name of the S3 directory bucket to which the policy applies.
	Bucket string `pulumi:"bucket"`
}

type LookupBucketPolicyOutputArgs 

type LookupBucketPolicyOutputArgs struct {
	// The name of the S3 directory bucket to which the policy applies.
	Bucket pulumi.StringInput `pulumi:"bucket"`
}

func (LookupBucketPolicyOutputArgs) ElementType 

func (LookupBucketPolicyOutputArgs) ElementType() reflect.Type

type LookupBucketPolicyResult 

type LookupBucketPolicyResult struct {
	// A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::S3Express::BucketPolicy` for more information about the expected schema for this property.
	PolicyDocument interface{} `pulumi:"policyDocument"`
}

func LookupBucketPolicy 

func LookupBucketPolicy(ctx *pulumi.Context, args *LookupBucketPolicyArgs, opts ...pulumi.InvokeOption) (*LookupBucketPolicyResult, error)

Resource Type definition for AWS::S3Express::BucketPolicy.

type LookupBucketPolicyResultOutput 

type LookupBucketPolicyResultOutput struct{ *pulumi.OutputState }

func LookupBucketPolicyOutput 

func LookupBucketPolicyOutput(ctx *pulumi.Context, args LookupBucketPolicyOutputArgs, opts ...pulumi.InvokeOption) LookupBucketPolicyResultOutput

func (LookupBucketPolicyResultOutput) ElementType 

func (LookupBucketPolicyResultOutput) ElementType() reflect.Type

func (LookupBucketPolicyResultOutput) PolicyDocument 

func (o LookupBucketPolicyResultOutput) PolicyDocument() pulumi.AnyOutput

A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::S3Express::BucketPolicy` for more information about the expected schema for this property.

func (LookupBucketPolicyResultOutput) ToLookupBucketPolicyResultOutput 

func (o LookupBucketPolicyResultOutput) ToLookupBucketPolicyResultOutput() LookupBucketPolicyResultOutput

func (LookupBucketPolicyResultOutput) ToLookupBucketPolicyResultOutputWithContext 

func (o LookupBucketPolicyResultOutput) ToLookupBucketPolicyResultOutputWithContext(ctx context.Context) LookupBucketPolicyResultOutput

type LookupDirectoryBucketArgs 

type LookupDirectoryBucketArgs struct {
	// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
	BucketName string `pulumi:"bucketName"`
}

type LookupDirectoryBucketOutputArgs 

type LookupDirectoryBucketOutputArgs struct {
	// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
	BucketName pulumi.StringInput `pulumi:"bucketName"`
}

func (LookupDirectoryBucketOutputArgs) ElementType 

func (LookupDirectoryBucketOutputArgs) ElementType() reflect.Type

type LookupDirectoryBucketResult 

type LookupDirectoryBucketResult struct {
	// Returns the Amazon Resource Name (ARN) of the specified bucket.
	Arn *string `pulumi:"arn"`
}

func LookupDirectoryBucket 

func LookupDirectoryBucket(ctx *pulumi.Context, args *LookupDirectoryBucketArgs, opts ...pulumi.InvokeOption) (*LookupDirectoryBucketResult, error)

Resource Type definition for AWS::S3Express::DirectoryBucket.

type LookupDirectoryBucketResultOutput 

type LookupDirectoryBucketResultOutput struct{ *pulumi.OutputState }

func LookupDirectoryBucketOutput 

func LookupDirectoryBucketOutput(ctx *pulumi.Context, args LookupDirectoryBucketOutputArgs, opts ...pulumi.InvokeOption) LookupDirectoryBucketResultOutput

func (LookupDirectoryBucketResultOutput) Arn 

func (o LookupDirectoryBucketResultOutput) Arn() pulumi.StringPtrOutput

Returns the Amazon Resource Name (ARN) of the specified bucket.

func (LookupDirectoryBucketResultOutput) ElementType 

func (LookupDirectoryBucketResultOutput) ElementType() reflect.Type

func (LookupDirectoryBucketResultOutput) ToLookupDirectoryBucketResultOutput 

func (o LookupDirectoryBucketResultOutput) ToLookupDirectoryBucketResultOutput() LookupDirectoryBucketResultOutput

func (LookupDirectoryBucketResultOutput) ToLookupDirectoryBucketResultOutputWithContext 

func (o LookupDirectoryBucketResultOutput) ToLookupDirectoryBucketResultOutputWithContext(ctx context.Context) LookupDirectoryBucketResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.