Skip to content

BucketLogging

This class encapsulates and extends the ROS resource type ALIYUN::OSS::BucketLogging.

Initializers

import com.aliyun.ros.cdk.oss.BucketLogging;
BucketLogging.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bucket(java.lang.String)
    .bucket(IResolvable)
    .targetBucket(java.lang.String)
    .targetBucket(IResolvable)
//  .loggingRole(java.lang.String)
//  .loggingRole(IResolvable)
//  .targetPrefix(java.lang.String)
//  .targetPrefix(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
bucket java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bucket: The name of the bucket.
targetBucket java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetBucket: The bucket that stores access logs.
loggingRole java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loggingRole: Authorization role used for bucket logging.
targetPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetPrefix: The prefix of the saved log objects.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bucketRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bucket: The name of the bucket.


targetBucketRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetBucket: The bucket that stores access logs.


loggingRoleOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property loggingRole: Authorization role used for bucket logging.


targetPrefixOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetPrefix: The prefix of the saved log objects.

This element can be left empty.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.oss.BucketLogging;
BucketLogging.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrLoggingRole java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoggingRole: Authorization role used for bucket logging.
attrTargetBucket java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TargetBucket: The bucket that stores access logs.
attrTargetPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TargetPrefix: The prefix of the saved log objects.
props BucketLoggingProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrLoggingRoleRequired

public java.lang.Object getAttrLoggingRole();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LoggingRole: Authorization role used for bucket logging.


attrTargetBucketRequired

public java.lang.Object getAttrTargetBucket();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TargetBucket: The bucket that stores access logs.


attrTargetPrefixRequired

public java.lang.Object getAttrTargetPrefix();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TargetPrefix: The prefix of the saved log objects.

This element can be left empty.


propsRequired

public BucketLoggingProps getProps();