• Home
• software.amazon.awscdk
• iot
• 1.139.0
• source code
• CfnScheduledAudit.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

software.amazon.awscdk.services.iot.CfnScheduledAudit Maven / Gradle / Ivy

package software.amazon.awscdk.services.iot;

/**
 * A CloudFormation `AWS::IoT::ScheduledAudit`.
 * 

 * Use the AWS::IoT::ScheduledAudit resource to create a scheduled audit that is run at a specified time interval. For API reference, see CreateScheduleAudit and for general information, see Audit .
 * 

 * Example:
 * 

 * 
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import software.amazon.awscdk.services.iot.*;
 * CfnScheduledAudit cfnScheduledAudit = CfnScheduledAudit.Builder.create(this, "MyCfnScheduledAudit")
 *         .frequency("frequency")
 *         .targetCheckNames(List.of("targetCheckNames"))
 *         // the properties below are optional
 *         .dayOfMonth("dayOfMonth")
 *         .dayOfWeek("dayOfWeek")
 *         .scheduledAuditName("scheduledAuditName")
 *         .tags(List.of(CfnTag.builder()
 *                 .key("key")
 *                 .value("value")
 *                 .build()))
 *         .build();
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.50.0 (build d1830a4)", date = "2022-01-11T17:58:42.053Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.iot.$Module.class, fqn = "@aws-cdk/aws-iot.CfnScheduledAudit")
public class CfnScheduledAudit extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.IInspectable {

    protected CfnScheduledAudit(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected CfnScheduledAudit(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    static {
        CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(software.amazon.awscdk.services.iot.CfnScheduledAudit.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Create a new `AWS::IoT::ScheduledAudit`.
     * 

     * @param scope - scope in which this resource is defined. This parameter is required.
     * @param id - scoped id of the resource. This parameter is required.
     * @param props - resource properties. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public CfnScheduledAudit(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iot.CfnScheduledAuditProps props) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * Examines the CloudFormation resource and discloses attributes.
     * 

     * @param inspector - tree inspector to collect and process attributes. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @Override
    public void inspect(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.TreeInspector inspector) {
        software.amazon.jsii.Kernel.call(this, "inspect", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(inspector, "inspector is required") });
    }

    /**
     * @param props This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @Override
    protected @org.jetbrains.annotations.NotNull java.util.Map renderProperties(final @org.jetbrains.annotations.NotNull java.util.Map props) {
        return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.call(this, "renderProperties", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class)), new Object[] { java.util.Objects.requireNonNull(props, "props is required") }));
    }

    /**
     * The CloudFormation resource type name for this resource class.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public final static java.lang.String CFN_RESOURCE_TYPE_NAME;

    /**
     * The ARN of the scheduled audit.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrScheduledAuditArn() {
        return software.amazon.jsii.Kernel.get(this, "attrScheduledAuditArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    protected @org.jetbrains.annotations.NotNull java.util.Map getCfnProperties() {
        return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "cfnProperties", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
    }

    /**
     * Metadata that can be used to manage the scheduled audit.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.TagManager getTags() {
        return software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.core.TagManager.class));
    }

    /**
     * How often the scheduled audit occurs.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getFrequency() {
        return software.amazon.jsii.Kernel.get(this, "frequency", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * How often the scheduled audit occurs.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void setFrequency(final @org.jetbrains.annotations.NotNull java.lang.String value) {
        software.amazon.jsii.Kernel.set(this, "frequency", java.util.Objects.requireNonNull(value, "frequency is required"));
    }

    /**
     * Which checks are performed during the scheduled audit.
     * 

     * Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
     * 

     * The following checks are currently aviable:
     * 

     * 

     * 
AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
     * 
CA_CERTIFICATE_EXPIRING_CHECK
     * 
CA_CERTIFICATE_KEY_QUALITY_CHECK
     * 
CONFLICTING_CLIENT_IDS_CHECK
     * 
DEVICE_CERTIFICATE_EXPIRING_CHECK
     * 
DEVICE_CERTIFICATE_KEY_QUALITY_CHECK
     * 
DEVICE_CERTIFICATE_SHARED_CHECK
     * 
IOT_POLICY_OVERLY_PERMISSIVE_CHECK
     * 
IOT_ROLE_ALIAS_ALLOWS_ACCESS_TO_UNUSED_SERVICES_CHECK
     * 
IOT_ROLE_ALIAS_OVERLY_PERMISSIVE_CHECK
     * 
LOGGING_DISABLED_CHECK
     * 
REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
     * 
REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK
     * 
UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
     * 
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.util.List getTargetCheckNames() {
        return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "targetCheckNames", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))));
    }

    /**
     * Which checks are performed during the scheduled audit.
     * 

     * Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
     * 

     * The following checks are currently aviable:
     * 

     * 

     * 
AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
     * 
CA_CERTIFICATE_EXPIRING_CHECK
     * 
CA_CERTIFICATE_KEY_QUALITY_CHECK
     * 
CONFLICTING_CLIENT_IDS_CHECK
     * 
DEVICE_CERTIFICATE_EXPIRING_CHECK
     * 
DEVICE_CERTIFICATE_KEY_QUALITY_CHECK
     * 
DEVICE_CERTIFICATE_SHARED_CHECK
     * 
IOT_POLICY_OVERLY_PERMISSIVE_CHECK
     * 
IOT_ROLE_ALIAS_ALLOWS_ACCESS_TO_UNUSED_SERVICES_CHECK
     * 
IOT_ROLE_ALIAS_OVERLY_PERMISSIVE_CHECK
     * 
LOGGING_DISABLED_CHECK
     * 
REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
     * 
REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK
     * 
UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
     * 
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void setTargetCheckNames(final @org.jetbrains.annotations.NotNull java.util.List value) {
        software.amazon.jsii.Kernel.set(this, "targetCheckNames", java.util.Objects.requireNonNull(value, "targetCheckNames is required"));
    }

    /**
     * The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY").
     * 

     * If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.Nullable java.lang.String getDayOfMonth() {
        return software.amazon.jsii.Kernel.get(this, "dayOfMonth", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY").
     * 

     * If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void setDayOfMonth(final @org.jetbrains.annotations.Nullable java.lang.String value) {
        software.amazon.jsii.Kernel.set(this, "dayOfMonth", value);
    }

    /**
     * The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY").
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.Nullable java.lang.String getDayOfWeek() {
        return software.amazon.jsii.Kernel.get(this, "dayOfWeek", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY").
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void setDayOfWeek(final @org.jetbrains.annotations.Nullable java.lang.String value) {
        software.amazon.jsii.Kernel.set(this, "dayOfWeek", value);
    }

    /**
     * The name of the scheduled audit.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.Nullable java.lang.String getScheduledAuditName() {
        return software.amazon.jsii.Kernel.get(this, "scheduledAuditName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * The name of the scheduled audit.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void setScheduledAuditName(final @org.jetbrains.annotations.Nullable java.lang.String value) {
        software.amazon.jsii.Kernel.set(this, "scheduledAuditName", value);
    }

    /**
     * A fluent builder for {@link software.amazon.awscdk.services.iot.CfnScheduledAudit}.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static final class Builder implements software.amazon.jsii.Builder {
        /**
         * @return a new instance of {@link Builder}.
         * @param scope - scope in which this resource is defined. This parameter is required.
         * @param id - scoped id of the resource. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public static Builder create(final software.amazon.awscdk.core.Construct scope, final java.lang.String id) {
            return new Builder(scope, id);
        }

        private final software.amazon.awscdk.core.Construct scope;
        private final java.lang.String id;
        private final software.amazon.awscdk.services.iot.CfnScheduledAuditProps.Builder props;

        private Builder(final software.amazon.awscdk.core.Construct scope, final java.lang.String id) {
            this.scope = scope;
            this.id = id;
            this.props = new software.amazon.awscdk.services.iot.CfnScheduledAuditProps.Builder();
        }

        /**
         * How often the scheduled audit occurs.
         * 

         * @return {@code this}
         * @param frequency How often the scheduled audit occurs. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder frequency(final java.lang.String frequency) {
            this.props.frequency(frequency);
            return this;
        }

        /**
         * Which checks are performed during the scheduled audit.
         * 

         * Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
         * 

         * The following checks are currently aviable:
         * 

         * 

         * 
AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
         * 
CA_CERTIFICATE_EXPIRING_CHECK
         * 
CA_CERTIFICATE_KEY_QUALITY_CHECK
         * 
CONFLICTING_CLIENT_IDS_CHECK
         * 
DEVICE_CERTIFICATE_EXPIRING_CHECK
         * 
DEVICE_CERTIFICATE_KEY_QUALITY_CHECK
         * 
DEVICE_CERTIFICATE_SHARED_CHECK
         * 
IOT_POLICY_OVERLY_PERMISSIVE_CHECK
         * 
IOT_ROLE_ALIAS_ALLOWS_ACCESS_TO_UNUSED_SERVICES_CHECK
         * 
IOT_ROLE_ALIAS_OVERLY_PERMISSIVE_CHECK
         * 
LOGGING_DISABLED_CHECK
         * 
REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
         * 
REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK
         * 
UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
         * 
         * 

         * @return {@code this}
         * @param targetCheckNames Which checks are performed during the scheduled audit. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder targetCheckNames(final java.util.List targetCheckNames) {
            this.props.targetCheckNames(targetCheckNames);
            return this;
        }

        /**
         * The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY").
         * 

         * If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
         * 

         * @return {@code this}
         * @param dayOfMonth The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY"). This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder dayOfMonth(final java.lang.String dayOfMonth) {
            this.props.dayOfMonth(dayOfMonth);
            return this;
        }

        /**
         * The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY").
         * 

         * @return {@code this}
         * @param dayOfWeek The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY"). This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder dayOfWeek(final java.lang.String dayOfWeek) {
            this.props.dayOfWeek(dayOfWeek);
            return this;
        }

        /**
         * The name of the scheduled audit.
         * 

         * @return {@code this}
         * @param scheduledAuditName The name of the scheduled audit. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder scheduledAuditName(final java.lang.String scheduledAuditName) {
            this.props.scheduledAuditName(scheduledAuditName);
            return this;
        }

        /**
         * Metadata that can be used to manage the scheduled audit.
         * 

         * @return {@code this}
         * @param tags Metadata that can be used to manage the scheduled audit. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder tags(final java.util.List tags) {
            this.props.tags(tags);
            return this;
        }

        /**
         * @returns a newly built instance of {@link software.amazon.awscdk.services.iot.CfnScheduledAudit}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public software.amazon.awscdk.services.iot.CfnScheduledAudit build() {
            return new software.amazon.awscdk.services.iot.CfnScheduledAudit(
                this.scope,
                this.id,
                this.props.build()
            );
        }
    }
}