Class S3SourceOptions
Options for S3 sources.
Inheritance
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3SourceOptions : Object, IS3SourceOptions
Syntax (vb)
Public Class S3SourceOptions
Inherits Object
Implements IS3SourceOptions
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.AWS.CodePipeline.Actions;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Pipelines;
Role role;
var s3SourceOptions = new S3SourceOptions {
ActionName = "actionName",
Role = role,
Trigger = S3Trigger.NONE
};
Synopsis
Constructors
S3SourceOptions() |
Properties
ActionName | The action name used for this source in the CodePipeline. |
Role | The role that will be assumed by the pipeline prior to executing the |
Trigger | How should CodePipeline detect source changes for this Action. |
Constructors
S3SourceOptions()
public S3SourceOptions()
Properties
ActionName
The action name used for this source in the CodePipeline.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Default: - The bucket name
Role
The role that will be assumed by the pipeline prior to executing the S3Source
action.
public IRole Role { get; set; }
Property Value
Remarks
Default: - a new role will be generated
Trigger
How should CodePipeline detect source changes for this Action.
public Nullable<S3Trigger> Trigger { get; set; }
Property Value
System.Nullable<S3Trigger>
Remarks
Note that if this is S3Trigger.EVENTS, you need to make sure to include the source Bucket in a CloudTrail Trail, as otherwise the CloudWatch Events will not be emitted.
Default: S3Trigger.POLL
See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/log-s3-data-events.html