Show / Hide Table of Contents

Class S3ImportSource

An import source from an S3 object.

Inheritance
object
ImportSource
S3ImportSource
Inherited Members
ImportSource.FromAsset(string, IAssetOptions)
ImportSource.FromBucket(IBucket, string)
ImportSource.FromInline(string)
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3ImportSource : ImportSource
Syntax (vb)
Public Class S3ImportSource Inherits ImportSource
Remarks

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;
            using Amazon.CDK.AWS.CloudFront;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.Interfaces.KMS;

            DockerImage dockerImage;
            IGrantable grantable;
            IKeyRef keyRef;
            ILocalBundling localBundling;

            var s3ImportSource = S3ImportSource.FromAsset("path", new AssetOptions {
                AssetHash = "assetHash",
                AssetHashType = AssetHashType.SOURCE,
                Bundling = new BundlingOptions {
                    Image = dockerImage,

                    // the properties below are optional
                    BundlingFileAccess = BundlingFileAccess.VOLUME_COPY,
                    Command = new [] { "command" },
                    Entrypoint = new [] { "entrypoint" },
                    Environment = new Dictionary<string, string> {
                        { "environmentKey", "environment" }
                    },
                    Local = localBundling,
                    Network = "network",
                    OutputType = BundlingOutput.ARCHIVED,
                    Platform = "platform",
                    SecurityOpt = "securityOpt",
                    User = "user",
                    Volumes = new [] { new DockerVolume {
                        ContainerPath = "containerPath",
                        HostPath = "hostPath",

                        // the properties below are optional
                        Consistency = DockerVolumeConsistency.CONSISTENT
                    } },
                    VolumesFrom = new [] { "volumesFrom" },
                    WorkingDirectory = "workingDirectory"
                },
                DeployTime = false,
                DisplayName = "displayName",
                Exclude = new [] { "exclude" },
                FollowSymlinks = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB,
                Readers = new [] { grantable },
                SourceKMSKey = keyRef
            });

Synopsis

Constructors

S3ImportSource(IBucket, string)

An import source from an S3 object.

Properties

Bucket

the S3 bucket that contains the data.

Key

the key within the S3 bucket that contains the data.

Constructors

S3ImportSource(IBucket, string)

An import source from an S3 object.

public S3ImportSource(IBucket bucket, string key)
Parameters
bucket IBucket

the S3 bucket that contains the data.

key string

the key within the S3 bucket that contains the data.

Remarks

ExampleMetadata: fixture=_generated

Properties

Bucket

the S3 bucket that contains the data.

public virtual IBucket Bucket { get; }
Property Value

IBucket

Remarks

ExampleMetadata: fixture=_generated

Key

the key within the S3 bucket that contains the data.

public virtual string Key { get; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Back to top Generated by DocFX